Update numpydoc config for hook changes.

stefmolin · Sep 23, 2023 · 304c53a · 304c53a
1 parent 4675a03
commit 304c53a
Showing 1 changed file with 16 additions and 7 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -161,11 +161,20 @@ markers = [
 ]
 
 [tool.numpydoc_validation]
-ignore = [
-    "EX01",
-    "SA01",
-    "SS06",
-    "ES01",
+checks = [
+    "all",  # report on all checks
+    "ES01", # but don't require an extended summary
+    "EX01", # or examples
+    "SA01", # or a see also section
+    "SS06", # and don't require the summary to fit on one line
+]
+exclude = [  # don't report on checks for these
+    '\.__init__$',
+    '\.__repr__$',
+    '\.__str__$',
+]
+override_SS05 = [  # allow docstrings to start with these words
+    '^Process ',
+    '^Assess ',
+    '^Access ',
 ]
-override_SS05 = '^((Process|Assess|Access) )'
-override_GL08 = '^(__(init|repr|str)__)$'