Merge pull request #138 from stefmolin/pre-commit-update

Pre commit updates
stefmolin · Sep 23, 2023 · 6ecd0bf · 6ecd0bf
2 parents 5fe0cfe + 304c53a
commit 6ecd0bf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 10 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,13 +24,13 @@ repos:
           - tomli
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.284
+    rev: v0.0.291
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --show-fixes]
 
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.9.1
     hooks:
       - id: black
 
@@ -43,7 +43,7 @@ repos:
           - black
 
   - repo: https://github.com/numpy/numpydoc
-    rev: v1.6.0rc1
+    rev: v1.6.0rc2
     hooks:
       - id: numpydoc-validation
         exclude: (tests/|docs/).*

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)__)$'