From 4675a03e7a9a2ddbd18a4d428a2dd8ffe2d9a596 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Sat, 23 Sep 2023 19:10:10 +0100 Subject: [PATCH 1/2] Update pre-commit hook versions. --- .pre-commit-config.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a1270dfc..f76d6287 100644 --- 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/).* From 304c53a79c2c1150bdc801602aec796be76ea796 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Sat, 23 Sep 2023 19:23:32 +0100 Subject: [PATCH 2/2] Update numpydoc config for hook changes. --- pyproject.toml | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 6a8f769d..68588e9e 100644 --- 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)__)$'