Add hook for pydoc

tradewelltech · Jun 21, 2023 · ad10948 · ad10948
1 parent c807bef
commit ad10948
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,3 +29,10 @@ repos:
         additional_dependencies:
           - toml
         args: [--config=pyproject.toml]
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        files: ^beavers/replay.py
+        additional_dependencies:
+          - tomli
diff --git a/beavers/__init__.py b/beavers/__init__.py
@@ -0,0 +1 @@
+"""beavers package module"""
diff --git a/beavers/engine.py b/beavers/engine.py
@@ -1,3 +1,4 @@
+"""Module for building and representing dags and nodes"""
 from __future__ import annotations
 
 import collections.abc

diff --git a/pyproject.toml b/pyproject.toml
@@ -66,3 +66,6 @@ folders = [ {path = "beavers"}]
 
 [tool.ruff]
 line-length = 88
+
+[tool.pydocstyle]
+ignore = ["D102", "D107", "D203", "D212"]