build(deps): add pydoclint (#228)

* style: fix typo in docstring

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

.flake8

@@ -1,5 +1,10 @@
 [flake8]
-ignore = F821
+ignore = DOC301, F821
 max-complexity = 10
 max-doc-length = 72
-max-line-length = 88
+max-line-length = 88
+# pydoclint
+style = google
+arg-type-hints-in-signature = False
+arg-type-hints-in-docstring = False
+check-return-types = False

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+    rev: 6.0.0
     hooks:
       - id: isort
   - repo: https://github.com/coatl-dev/docformatter
@@ -28,15 +28,18 @@ repos:
     rev: 6.3.0
     hooks:
       - id: pydocstyle
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.6.0
+    hooks:
+      - id: pydoclint-flake8
+  - repo: https://github.com/coatl-dev/hadolint-coatl
+    rev: 2.12.1b0
+    hooks:
+      - id: hadolint
   - repo: local
     hooks:
       - id: pylint
         name: pylint
         entry: pylint
         language: system
-        files: ^src/
         types: [python]
-  - repo: https://github.com/coatl-dev/hadolint-coatl
-    rev: 2.12.1b0
-    hooks:
-      - id: hadolint

Makefile

@@ -5,7 +5,7 @@ JYTHON_CACHE_DIR := $$HOME/.cache/jython
 
 ##@ Help
 
-.PHONY: help clean check init install install-clean install-force install-nocache install-nodeps
+.PHONY: help clean check init install cleaninstall forceinstall nocacheinstall nodepsinstall
 
 help: ## Display this help message.
 	@awk \
@@ -44,18 +44,18 @@ install: check init ## Install this package using Jython with caching enabled.
 	@echo "Installing package…"
 	jython -m pip install --cache-dir="$(JYTHON_CACHE_DIR)" .
 
-install-clean: check init clean ## Perform clean installation using Jython with caching enabled.
+cleaninstall: check init clean ## Perform clean installation using Jython with caching enabled.
 	@echo "Running clean install…"
 	jython -m pip install --cache-dir="$(JYTHON_CACHE_DIR)" .
 
-install-force: check init ## Reinstall all packages using Jython even if they are already up-to-date.
+forceinstall: check init ## Reinstall all packages using Jython even if they are already up-to-date.
 	@echo "Reinstalling all packages…"
 	jython -m pip install --force-reinstall --cache-dir="$(JYTHON_CACHE_DIR)" .
 
-install-nocache: check ## Install this package using Jython with caching disabled.
+nocacheinstall: check ## Install this package using Jython with caching disabled.
 	@echo "Installing packages (no cache)…"
 	jython -m pip install --no-cache-dir .
 
-install-nodeps: check ## Install this package without dependencies.
+nodepsinstall: check ## Install this package without dependencies.
 	@echo "Installing package without dependencies…"
 	jython -m pip install --no-deps .

src/incendium/db.py

@@ -76,7 +76,10 @@ def __enter__(self):
 
         Raises:
             IOError: If the connection's status reports as Faulted, or
-                ir cannot be enabled.
+                it cannot be enabled.
+
+        Returns:
+            DisposableConnection: The current instance.
         """
         system.db.setDatasourceEnabled(self._database, True)