Switch from darglint to pydoclint (#232)

ansible · Oct 25, 2023 · a5d7868 · a5d7868
1 parent 7148803
commit a5d7868
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/.darglint b/.darglint
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -57,16 +57,21 @@ repos:
       - id: cspell
         name: Spell check with cspell
 
-  # untill ruff has parity with darglint
   - repo: https://github.com/PyCQA/flake8.git
     rev: 6.1.0
     hooks:
       - id: flake8
         language_version: python3
         additional_dependencies:
-          - darglint
           - flake8-docstrings
 
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.3.4
+    hooks:
+      - id: pydoclint
+        args:
+          - "--config=pyproject.toml"
+
   - repo: https://github.com/pycqa/pylint.git
     rev: v3.0.1
     hooks:

diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,12 @@ write_to = "src/tox_ansible/_version.py"
 [tool.black]
 line-length = 100
 
+[tool.pydoclint]
+allow-init-docstring = true
+arg-type-hints-in-docstring = false
+check-return-types = false
+style = 'google'
+
 [tool.pylint]
 
 [tool.pylint.format]