Merge branch 'ConstructorChecking_ASTValidator' of https://github.com/mattgebert/numpydoc into ConstructorChecking_ASTValidator

Author: mattgebert

.github/workflows/milestone-merged-prs.yml

@@ -12,7 +12,7 @@ jobs:
     name: attach to PR
     runs-on: ubuntu-latest
     steps:
-      - uses: scientific-python/attach-next-milestone-action@bc07be829f693829263e57d5e8489f4e57d3d420
+      - uses: scientific-python/attach-next-milestone-action@c9cfab10ad0c67fed91b01103db26b7f16634639
         with:
           token: ${{ secrets.MILESTONE_LABELER_TOKEN }}
           force: true

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
           pip install -U build twine wheel
           python -m build --sdist --wheel
       - run: twine check --strict dist/*
-      - uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: dist
           path: dist
@@ -40,7 +40,7 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-      - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+      - uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
         with:
           name: dist
           path: dist

.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
         args: [--prose-wrap=preserve]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "89c421dff2e1026ba12cdb9ebd731f4a83aa8021" # frozen: v0.8.6
+    rev: "971923581912ef60a6b70dbf0c3e9a39563c9d47" # frozen: v0.11.4
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes", "--exit-non-zero-on-fix"]

numpydoc/cli.py

@@ -104,10 +104,11 @@ def _parse_config(s):
         nargs="*",
         help=(
             f"""Check codes to ignore.{
-                ' Currently ignoring the following from '
-                f'{Path(project_root_from_cwd) / config_file}: {ignored_checks_text}'
-                'Values provided here will be in addition to the above, unless an alternate config is provided.'
-                if ignored_checks else ''
+                " Currently ignoring the following from "
+                f"{Path(project_root_from_cwd) / config_file}: {ignored_checks_text}"
+                "Values provided here will be in addition to the above, unless an alternate config is provided."
+                if ignored_checks
+                else ""
             }"""
         ),
     )

numpydoc/docscrape.py

@@ -232,8 +232,7 @@ def _parse_param_list(self, content, single_element_is_type=False):
                 # NOTE: param line with single element should never have a
                 # a " :" before the description line, so this should probably
                 # warn.
-                if header.endswith(" :"):
-                    header = header[:-2]
+                header = header.removesuffix(" :")
                 if single_element_is_type:
                     arg_name, arg_type = "", header
                 else:

numpydoc/tests/hooks/example_module.py

@@ -23,8 +23,8 @@ def do_something(self, *args, **kwargs):
         *args
         """
 
-    def process(self):
-        """Process stuff."""
+    def create(self):
+        """Creates stuff."""
 
 
 class NewClass:

numpydoc/tests/hooks/test_validate_hook.py

@@ -116,9 +116,7 @@ def test_validate_hook_with_toml_config(example_module, tmp_path, capsys):
                 ]
                 exclude = '\\.__init__$'
                 override_SS05 = [
-                    '^Process',
-                    '^Assess',
-                    '^Access',
+                    '^Creates',
                 ]
                 """
             )
@@ -154,7 +152,7 @@ def test_validate_hook_with_setup_cfg(example_module, tmp_path, capsys):
                 [tool:numpydoc_validation]
                 checks = all,EX01,SA01,ES01
                 exclude = \\.__init__$
-                override_SS05 = ^Process,^Assess,^Access
+                override_SS05 = ^Creates
                 """
             )
         )
@@ -198,9 +196,7 @@ def test_validate_hook_exclude_option_pyproject(example_module, tmp_path, capsys
                     '\.__init__$',
                 ]
                 override_SS05 = [
-                    '^Process',
-                    '^Assess',
-                    '^Access',
+                    '^Creates',
                 ]
                 """
             )
@@ -232,7 +228,7 @@ def test_validate_hook_exclude_option_setup_cfg(example_module, tmp_path, capsys
                 [tool:numpydoc_validation]
                 checks = all,EX01,SA01,ES01
                 exclude = \\.NewClass$,\\.__init__$
-                override_SS05 = ^Process,^Assess,^Access
+                override_SS05 = ^Creates
                 """
             )
         )

numpydoc/validate.py

@@ -80,8 +80,7 @@
     "PR06": 'Parameter "{param_name}" type should use "{right_type}" instead '
     'of "{wrong_type}"',
     "PR07": 'Parameter "{param_name}" has no description',
-    "PR08": 'Parameter "{param_name}" description should start with a '
-    "capital letter",
+    "PR08": 'Parameter "{param_name}" description should start with a capital letter',
     "PR09": 'Parameter "{param_name}" description should finish with "."',
     "PR10": 'Parameter "{param_name}" requires a space before the colon '
     "separating the parameter name and type",
@@ -750,7 +749,13 @@ def validate(obj_name, validator_cls=None, **validator_kwargs):
             errs.append(error("SS03"))
         if doc.summary != doc.summary.lstrip():
             errs.append(error("SS04"))
-        elif doc.is_function_or_method and doc.summary.split(" ")[0][-1] == "s":
+        # Heuristic to check for infinitive verbs - shouldn't end in "s"
+        elif (
+            doc.is_function_or_method
+            and len(doc.summary.split(" ")[0]) > 1
+            and doc.summary.split(" ")[0][-1] == "s"
+            and doc.summary.split(" ")[0][-2] != "s"
+        ):
             errs.append(error("SS05"))
         if doc.num_summary_lines > 1:
             errs.append(error("SS06"))