Add pydoclint to pre-commit config (#198)

ansible · Oct 18, 2023 · 7bab2bb · 7bab2bb
1 parent 5ae04e4
commit 7bab2bb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -65,6 +65,12 @@ repos:
     rev: 0.27.0
     hooks:
       - id: check-github-workflows
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.3.4
+    hooks:
+      - id: pydoclint
+        args:
+          - "--config=pyproject.toml"
   - repo: https://github.com/pycqa/pylint
     rev: v3.0.1
     hooks:

diff --git a/pyproject.toml b/pyproject.toml
@@ -82,6 +82,12 @@ module = ["ansible.*"]
 ignore_missing_imports = true
 ignore_errors = true
 
+[tool.pydoclint]
+allow-init-docstring = true
+arg-type-hints-in-docstring = false
+check-return-types = false
+style = 'google'
+
 [tool.pylint.MAIN]
 extension-pkg-allow-list = ["black.parsing"]