docsig 0.90.3__tar.gz → 0.91.1__tar.gz

{docsig-0.90.3 → docsig-0.91.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsig
-Version: 0.90.3
+Version: 0.91.1
 Summary: Check signature params for proper documentation
 License-Expression: MIT
 License-File: LICENSE
@@ -59,7 +59,7 @@ Description-Content-Type: text/x-rst
    :target: https://docsig.io/en/latest/?badge=latest
    :alt: readthedocs.org
 .. |python3.10| image:: https://img.shields.io/badge/python-3.10-blue.svg
-   :target: https://www.python.org/downloads/release/python-390
+   :target: https://www.python.org/downloads/release/python-310
    :alt: python3.10
 .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
@@ -80,7 +80,7 @@ Description-Content-Type: text/x-rst
    :target: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml
    :alt: Build
 .. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
-   :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
+   :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml
    :alt: Build
 .. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
    :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
@@ -125,14 +125,14 @@ Commandline
                   [--check-protected-class-methods] [--ignore-args] [--ignore-kwargs]
                   [--ignore-no-params] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
                   [-i] [-s STR]
-                  [path [path ...]]
+                  [path ...]
 
     Check signature params for proper documentation
 
     positional arguments:
       path                  directories or files to check
 
-    optional arguments:
+    options:
       -h, --help            show this help message and exit
       -V, --version         show program's version number and exit
       -l, --list-checks     display a list of all checks and their messages
@@ -206,7 +206,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.90.3, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.91.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -292,7 +292,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.90.3
+        rev: v0.91.1
         hooks:
           - id: docsig
             args:
@@ -311,7 +311,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.90.3
+              - docsig==0.91.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.90.3 → docsig-0.91.1}/README.rst

@@ -31,7 +31,7 @@
    :target: https://docsig.io/en/latest/?badge=latest
    :alt: readthedocs.org
 .. |python3.10| image:: https://img.shields.io/badge/python-3.10-blue.svg
-   :target: https://www.python.org/downloads/release/python-390
+   :target: https://www.python.org/downloads/release/python-310
    :alt: python3.10
 .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
@@ -52,7 +52,7 @@
    :target: https://github.com/jshwi/docsig/actions/workflows/build-intellij-plugin.yaml
    :alt: Build
 .. |VS Code Build| image:: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml/badge.svg
-   :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml.yaml
+   :target: https://github.com/jshwi/docsig/actions/workflows/build-vscode-extension.yaml
    :alt: Build
 .. |VS Code Extension| image:: https://img.shields.io/badge/vscode%20extension-v1.0.1-007ACC
    :target: https://marketplace.visualstudio.com/items?itemName=jshwi.docsig
@@ -97,14 +97,14 @@ Commandline
                   [--check-protected-class-methods] [--ignore-args] [--ignore-kwargs]
                   [--ignore-no-params] [-d LIST] [-t LIST] [-e PATTERN] [-E PATH [PATH ...]]
                   [-i] [-s STR]
-                  [path [path ...]]
+                  [path ...]
 
     Check signature params for proper documentation
 
     positional arguments:
       path                  directories or files to check
 
-    optional arguments:
+    options:
       -h, --help            show this help message and exit
       -V, --version         show program's version number and exit
       -l, --list-checks     display a list of all checks and their messages
@@ -178,7 +178,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.3.0 (docsig: 0.90.3, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
+    7.3.0 (docsig: 0.91.1, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.10.19 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -264,7 +264,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.90.3
+        rev: v0.91.1
         hooks:
           - id: docsig
             args:
@@ -283,7 +283,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.90.3
+              - docsig==0.91.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

docsig-0.90.3/docsig/_report.py → docsig-0.91.1/docsig/_checker.py

@@ -1,24 +1,19 @@
 """
-docsig._report
-==============
+docsig._checker
+===============
 
-Collect and format docstring-check failures for reporting. This module
-defines Failure (per-function validation results), Failed (one reported
-issue), Failures (sequence of failures), and report() to print them and
-return the highest exit code.
+Run docstring and signature checks for a single function.
 """
 
 import contextlib as _contextlib
-import json as _json
-import os as _os
-import sys as _sys
 import typing as _t
-from dataclasses import dataclass as _dataclass
-from warnings import warn as _warn
 
 import astroid as _ast
 
 from ._config import Config as _Config
+from ._diagnostic import Collector as _Collector
+from ._diagnostic import Diagnostic as _Diagnostic
+from ._diagnostic import FunctionResult as _FunctionResult
 from ._module import Function as _Function
 from ._stub import UNNAMED as _UNNAMED
 from ._stub import VALID_DESCRIPTION as _VALID_DESCRIPTION
@@ -27,8 +22,6 @@ from ._stub import Params as _Params
 from ._stub import RetType as _RetType
 from ._utils import almost_equal as _almost_equal
 from ._utils import sentence_tokenizer as _sentence_tokenizer
-from .messages import NEW as _NEW
-from .messages import TEMPLATE as _TEMPLATE
 from .messages import E as _E
 from .messages import Message as _Message
 
@@ -36,56 +29,7 @@ _MIN_MATCH = 0.8
 _MAX_MATCH = 1.0
 
 
-def check_function(func: _Function, config: _Config) -> "FunctionChecker":
-    """Run configured checks for one function and return the result.
-
-    :param func: Function under check.
-    :param config: Configuration object.
-    :return: Collected diagnostics for the function.
-    """
-    return FunctionChecker(func, config)
-
-
-class RetCode:
-    """RetCode object.
-
-    :param code: Initial return code, if any, otherwise zero.
-    """
-
-    def __init__(self, code: int = 0) -> None:
-        self._data = [code]
-
-    def add(self, code: int) -> None:
-        """Add a return code.
-
-        :param code: Return code to add.
-        """
-        self._data.append(code)
-
-    @property
-    def result(self) -> int:
-        """Maximum return code."""
-        return max(self._data)
-
-
-class Failures(list["FunctionChecker"]):
-    """Sequence of Failure instances (one per function checked)."""
-
-
-@_dataclass(frozen=True, order=True)
-class Diagnostic:  # pylint: disable=too-few-public-methods
-    """Single reported issue."""
-
-    name: str
-    ref: str
-    description: str
-    symbolic: str
-    lineno: int
-    hint: str | None = None
-    new: bool = False
-
-
-class FunctionChecker(list[Diagnostic]):
+class FunctionChecker:  # pylint: disable=too-few-public-methods
     """Collect docstring and signature failures for one function.
 
     Runs configured checks and appends Failed entries for each
@@ -96,9 +40,9 @@ class FunctionChecker(list[Diagnostic]):
     """
 
     def __init__(self, func: _Function, config: _Config) -> None:
-        super().__init__()
-        self._retcode = RetCode()
         self._func = func
+        self._config = config
+        self._diagnostics: list[_Diagnostic] = []
         if config.target:
             self._func.messages.extend(
                 i for i in _E.all if i not in config.target
@@ -113,8 +57,15 @@ class FunctionChecker(list[Diagnostic]):
         ):
             self._name = f"{self._func.parent.name}.{self._name}"
 
+        self._collector = _Collector(func, self._name, self._func.lineno)
+
+    def run(self) -> _FunctionResult:
+        """Run the function checks and return the result.
+
+        :return: Function result.
+        """
         if self._func.error is not None:
-            self._retcode.add(2)
+            self._collector.retcode.add(2)
             self._sig9xx_error()
         else:
             self._sig0xx_config()
@@ -128,9 +79,9 @@ class FunctionChecker(list[Diagnostic]):
                     sig = self._func.signature.args.get(index)
                     self._sig4xx_parameters(doc, sig)
 
-                self._sig5xx_returns(config.check.property_returns)
+                self._sig5xx_returns(self._config.check.property_returns)
 
-        self.sort()
+        return _FunctionResult(self._name, self._func.lineno, self._collector)
 
     def _add(
         self,
@@ -138,18 +89,7 @@ class FunctionChecker(list[Diagnostic]):
         include_hint: bool = False,
         **kwargs: _t.Any,
     ) -> None:
-        self._retcode.add(int(not value.new))
-        failed = Diagnostic(
-            self._name,
-            value.ref,
-            value.description.format(**kwargs),
-            value.symbolic,
-            self.lineno,
-            value.hint if include_hint else None,
-            value.new,
-        )
-        if value not in self._func.messages and failed not in self:
-            super().append(failed)
+        self._collector.add(value, include_hint=include_hint, **kwargs)
 
     @staticmethod
     def _normalize_params(from_: _Params, to: _Params) -> None:
@@ -231,15 +171,17 @@ class FunctionChecker(list[Diagnostic]):
 
     def _sig2xx_signature(self) -> None:
         if self._func.docstring.args.duplicated:
-            # pop the duplicates so that they are considered a single
-            # parameter, that way there are no assumptions that the
-            # parameters must be out of order
-            for count, arg in enumerate(self._func.docstring.args):
-                if (
-                    arg in self._func.docstring.args.duplicates
-                    and self._func.docstring.args.count(arg) > 1
-                ):
-                    self._func.docstring.args.pop(count)
+            # reduce each duplicate group to one representative without
+            # mutating the list during iteration (which skips items)
+            seen: set[str | None] = set()
+            deduped: list[_Param] = []
+            for arg in self._func.docstring.args:
+                if arg.name not in seen:
+                    seen.add(arg.name)
+                    deduped.append(arg)
+
+            list.clear(self._func.docstring.args)
+            list.extend(self._func.docstring.args, deduped)
 
             # duplicate-params-found
             self._add(_E[201])
@@ -297,6 +239,8 @@ class FunctionChecker(list[Diagnostic]):
             not in (
                 "`",
                 ".",
+                "!",
+                "?",
             )
         ):
             self._add(_E[306])
@@ -371,7 +315,7 @@ class FunctionChecker(list[Diagnostic]):
         # invalid-syntax
         if self._func.error is _ast.AstroidSyntaxError:
             self._add(_E[901])
-            self._retcode.add(123)
+            self._collector.retcode.add(123)
         # unicode-decode-error
         if self._func.error is UnicodeDecodeError:
             self._add(_E[902])
@@ -381,81 +325,3 @@ class FunctionChecker(list[Diagnostic]):
         # duplicates-found-in-mros
         if self._func.error is _ast.DuplicateBasesError:
             self._add(_E[904])
-
-    @property
-    def name(self) -> str:
-        """Qualified name (Class.method) when nested, else bare name."""
-        return self._name
-
-    @property
-    def lineno(self) -> int:
-        """Line number of the function in the source."""
-        return self._func.lineno
-
-    @property
-    def retcode(self) -> int:
-        """Exit code (non-zero if any check failed)."""
-        return self._retcode.result
-
-
-# TODO: make report json by default and wrap with a reporter for cli
-def report(
-    failures: Failures,
-    config: _Config,
-    file: str | None = None,
-) -> int:
-    """Print failures to stdout and return the highest exit code.
-
-    Iterates over failures, prints each with path, line header, and
-    messages, then returns the maximum retcode (0 or non-zero).
-
-    :param failures: Failures to print (one Failure per function).
-    :param config: Config for ANSI and formatting.
-    :param file: Module path when failures came from a file (optional).
-    :return: Exit code (non-zero if any check failed).
-    """
-    format_json = _os.getenv("_DOCSIG_FORMAT_JSON") is not None
-    retcodes = RetCode()
-    output = []
-    obj = []
-    for result in failures:
-        retcodes.add(result.retcode)
-        path_prefix = f"{file}:" if file is not None else ""
-        header = f"{path_prefix}{result.lineno} in {result.name}"
-        if not config.no_ansi and _sys.stdout.isatty():
-            header = f"\033[35m{header}\033[0m"
-
-        output.append(header)
-        for item in result:
-            extra = None
-            if item.hint:
-                extra = f"hint: {item.hint}"
-
-            if item.new:
-                extra = "warning: please remember to fix this or disable it"
-                _warn(_NEW.format(ref=item.ref), FutureWarning, stacklevel=3)
-
-            msg = _TEMPLATE.format(
-                ref=item.ref,
-                description=item.description,
-                symbolic=item.symbolic,
-            )
-            output.append(f"    {msg}")
-            if extra is not None:
-                output.append(f"    {extra}")
-
-            obj.append(
-                {
-                    "line": None if result.retcode == 2 else item.lineno,
-                    "message": msg,
-                    "exit": result.retcode,
-                },
-            )
-
-    if format_json:
-        print(_json.dumps(obj).strip())  # pragma: no cover
-
-    elif output:
-        print("\n".join(output))
-
-    return retcodes.result

{docsig-0.90.3 → docsig-0.91.1}/docsig/_config.py

@@ -156,17 +156,10 @@ def build_parser() -> _ArgumentParser:
         action="store_true",
         help="check nested functions and classes",
     )
-    parser.add_argument(
-        "-o",
-        action="store_true",
-        help=_argparse.SUPPRESS,
-        dest="check_overridden",
-    )
     parser.add_argument(
         "--check-overridden",
         action="store_true",
         help="check overridden methods",
-        dest="check_overridden",
     )
     parser.add_argument(
         "--check-property-returns",
@@ -332,6 +325,14 @@ class Config:
 
     Groups check, ignore settings, and run options so the core runner
     takes a single config object instead of many parameters.
+
+    :param check: Configuration for which docstrings and members to
+        check.
+    :param ignore: Configuration for which docstring elements to ignore.
+    :param filters: Configuration for which paths to filter.
+    :param target: List of errors to target.
+    :param disable: List of errors to disable.
+    :param no_ansi: Disable ANSI output.
     """
 
     check: Check = _field(default_factory=Check)

{docsig-0.90.3 → docsig-0.91.1}/docsig/_core.py

@@ -12,17 +12,17 @@ from pathlib import Path as _Path
 from pprint import pformat as _pformat
 
 from . import _decorators
-from ._check import run_checks as _run_checks
 from ._config import Check as _Check
 from ._config import Config as _Config
 from ._config import Filters as _Filters
 from ._config import Ignore as _Ignore
+from ._diagnostic import Failures as _Failures
+from ._diagnostic import RetCode as _RetCode
 from ._files import Files as _Files
 from ._parsers import parse_from_file as _parse_from_file
 from ._parsers import parse_from_string as _parse_from_string
-from ._report import Failures as _Failures
-from ._report import RetCode as _RetCode
 from ._report import report as _report
+from ._traverse import run_checks as _run_checks
 from ._utils import get_parent_that_has as _get_parent_that_has
 from ._utils import print_checks as _print_checks
 from .messages import E as _E

{docsig-0.90.3 → docsig-0.91.1}/docsig/_decorators.py

@@ -10,7 +10,7 @@ import sys as _sys
 import typing as _t
 from pathlib import Path as _Path
 
-from ._report import RetCode as _RetCode
+from ._diagnostic import RetCode as _RetCode
 from .messages import E as _E
 
 _FuncType = _t.Callable[..., int]

docsig-0.91.1/docsig/_diagnostic.py

@@ -0,0 +1,155 @@
+"""
+docsig._diagnostic
+==================
+
+Diagnostic records and per-function check results for docsig runs.
+"""
+
+import typing as _t
+from dataclasses import dataclass as _dataclass
+
+from ._module import Function as _Function
+from .messages import Message as _Message
+
+
+class Failures(list["FunctionResult"]):
+    """Sequence of result instances (one per function checked)."""
+
+
+class RetCode:
+    """RetCode object.
+
+    :param code: Initial return code, if any, otherwise zero.
+    """
+
+    def __init__(self, code: int = 0) -> None:
+        self._data = [code]
+
+    def add(self, code: int) -> None:
+        """Add a return code.
+
+        :param code: Return code to add.
+        """
+        self._data.append(code)
+
+    @property
+    def result(self) -> int:
+        """Maximum return code."""
+        return max(self._data)
+
+
+@_dataclass(frozen=True, order=True)
+class Diagnostic:  # pylint: disable=too-few-public-methods
+    """Single reported issue for one function."""
+
+    name: str
+    ref: str
+    description: str
+    symbolic: str
+    lineno: int
+    hint: str | None = None
+    new: bool = False
+
+
+class Collector:
+    """Collect diagnostics and exit weights for one function.
+
+    :param func: Function to collect diagnostics for.
+    :param qualified_name: Qualified name (Class.method) when nested,
+        else bare name.
+    :param lineno: Line number of the function in the source.
+    """
+
+    def __init__(
+        self,
+        func: _Function,
+        qualified_name: str,
+        lineno: int,
+    ) -> None:
+        self._func = func
+        self._qualified_name = qualified_name
+        self._lineno = lineno
+        self._diagnostics: list[Diagnostic] = []
+        self._retcode = RetCode()
+
+    def add(
+        self,
+        value: _Message,
+        include_hint: bool = False,
+        **kwargs: _t.Any,
+    ) -> None:
+        """Add a diagnostic message.
+
+        :param value: Message to add.
+        :param include_hint: Whether to include the hint.
+        :param kwargs: Additional arguments to format the description.
+        """
+        self._retcode.add(int(not value.new))
+        diagnostic = Diagnostic(
+            self._qualified_name,
+            value.ref,
+            value.description.format(**kwargs),
+            value.symbolic,
+            self._lineno,
+            value.hint if include_hint else None,
+            value.new,
+        )
+        if (
+            value not in self._func.messages
+            and diagnostic not in self._diagnostics
+        ):
+            self._diagnostics.append(diagnostic)
+
+    @property
+    def diagnostics(self) -> list[Diagnostic]:
+        """Diagnostics sorted for stable output."""
+        return sorted(self._diagnostics)
+
+    @property
+    def retcode(self) -> RetCode:
+        """Exit code (non-zero if any check failed)."""
+        return self._retcode
+
+    def __bool__(self) -> bool:
+        return bool(self._diagnostics)
+
+
+class FunctionResult:
+    """Diagnostics and exit code for one checked function.
+
+    :param name: Qualified name (Class.method) when nested, else bare
+        name.
+    :param lineno: Line number of the function in the source.
+    :param collector: Collector for the function.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        lineno: int,
+        collector: Collector,
+    ) -> None:
+        self._name = name
+        self._lineno = lineno
+        self._collector = collector
+
+    @property
+    def name(self) -> str:
+        """Qualified name (Class.method) when nested, else bare name."""
+        return self._name
+
+    @property
+    def lineno(self) -> int:
+        """Line number of the function in the source."""
+        return self._lineno
+
+    @property
+    def retcode(self) -> int:
+        """Exit code (non-zero if any check failed)."""
+        return self._collector.retcode.result
+
+    def __iter__(self) -> _t.Iterator[Diagnostic]:
+        return iter(self._collector.diagnostics)
+
+    def __bool__(self) -> bool:
+        return bool(self._collector)

{docsig-0.90.3 → docsig-0.91.1}/docsig/_main.py

@@ -19,7 +19,6 @@ def _warn_on_deprecated_short_flags() -> None:
         "-I": "--include-ignored",
         "-c": "--check-class",
         "-D": "--check-dunders",
-        "-o": "--check-overridden",
     }
     raw_args = _sys.argv[1:]
     expanded_flags = []

{docsig-0.90.3 → docsig-0.91.1}/docsig/_parsers.py

@@ -25,9 +25,9 @@ def parse_from_string(
 ) -> _Parent:
     """Build a Parent from a string of Python code.
 
-    Parses AST and comment directives (AST does not include comments,
-    so directives are parsed separately). On syntax error, returns a
-    Parent with an error set.
+    Parses AST and comment directives (AST does not include comments, so
+    directives are parsed separately). On syntax error, returns a Parent
+    with an error set.
 
     :param code: Python source to parse.
     :param config: Configuration object.

docsig-0.91.1/docsig/_report.py

@@ -0,0 +1,94 @@
+"""
+docsig._report
+==============
+
+Format and print docstring-check diagnostics for CLI and tooling.
+"""
+
+import json as _json
+import os as _os
+import sys as _sys
+from warnings import warn as _warn
+
+from ._checker import FunctionChecker as _FunctionChecker
+from ._config import Config as _Config
+from ._diagnostic import Failures as _Failures
+from ._diagnostic import FunctionResult as _FunctionResult
+from ._diagnostic import RetCode as _RetCode
+from ._module import Function as _Function
+from .messages import NEW as _NEW
+from .messages import TEMPLATE as _TEMPLATE
+
+
+def check_function(func: _Function, config: _Config) -> _FunctionResult:
+    """Run configured checks for one function and return the result.
+
+    :param func: Function under check.
+    :param config: Configuration object.
+    :return: Collected diagnostics for the function.
+    """
+    return _FunctionChecker(func, config).run()
+
+
+# TODO: make report json by default and wrap with a reporter for cli
+def report(
+    failures: _Failures,
+    config: _Config,
+    file: str | None = None,
+) -> int:
+    """Print failures and return the highest exit code.
+
+    Iterates over failures, prints each with path, line header, and
+    messages, then returns the maximum retcode (0 or non-zero).
+
+    :param failures: Failures to print (one FunctionResult per
+        function).
+    :param config: Config for ANSI and formatting.
+    :param file: Module path when failures came from a file (optional).
+    :return: Exit code (non-zero if any check failed).
+    """
+    format_json = _os.getenv("_DOCSIG_FORMAT_JSON") is not None
+    retcodes = _RetCode()
+    output = []
+    obj = []
+    for result in failures:
+        retcodes.add(result.retcode)
+        path_prefix = f"{file}:" if file is not None else ""
+        header = f"{path_prefix}{result.lineno} in {result.name}"
+        if not config.no_ansi and _sys.stdout.isatty():
+            header = f"\033[35m{header}\033[0m"
+
+        output.append(header)
+        for item in result:
+            extra = None
+            if item.hint:
+                extra = f"hint: {item.hint}"
+
+            if item.new:
+                extra = "warning: please remember to fix this or disable it"
+                _warn(_NEW.format(ref=item.ref), FutureWarning, stacklevel=3)
+
+            msg = _TEMPLATE.format(
+                ref=item.ref,
+                description=item.description,
+                symbolic=item.symbolic,
+            )
+            output.append(f"    {msg}")
+            if extra is not None:
+                output.append(f"    {extra}")
+
+            obj.append(
+                {
+                    "line": None if result.retcode == 2 else item.lineno,
+                    "message": msg,
+                    "exit": result.retcode,
+                },
+            )
+
+    if format_json:
+        print(_json.dumps(obj).strip())  # pragma: no cover
+
+    elif output:
+        print("\n".join(output))
+
+    return retcodes.result

{docsig-0.90.3 → docsig-0.91.1}/docsig/_stub.py

@@ -179,7 +179,6 @@ class Params(list[Param]):
     def __init__(self, ignore: _Ignore) -> None:
         super().__init__()
         self._ignore = ignore
-        self._duplicates: list[Param] = []
 
     def append(self, value: Param) -> None:
         if not value.isprotected and any(
@@ -219,20 +218,7 @@ class Params(list[Param]):
 
         Only names are compared; descriptions are ignored.
         """
-        for k, v in _Counter(i.name for i in self).items():
-            if v > 1:
-                for i in self:
-                    if i.name == k:
-                        # record the duplicates for later analysis
-                        self._duplicates.append(i)
-                        return True
-
-        return False
-
-    @property
-    def duplicates(self) -> list[Param]:
-        """Params that share a name."""
-        return self._duplicates
+        return any(v > 1 for v in _Counter(i.name for i in self).values())
 
 
 class _Stub:
@@ -394,7 +380,7 @@ class Docstring(_Stub):
         indent_anomaly = cls._indent_anomaly(node.value)
         string = cls._normalize_docstring(node.value)
         match = _re.search(
-            r"^[ \t]*:(?:returns?|yields?):\s*(.*)",
+            r"^[ \t]*:(?:returns?|yields?|rtype):\s*(.*)",
             string,
             _re.IGNORECASE | _re.MULTILINE,
         )

docsig-0.90.3/docsig/_check.py → docsig-0.91.1/docsig/_traverse.py

@@ -1,12 +1,14 @@
 """
-docsig._check
-=============
+docsig._traverse
+================
+
+Traverse modules and run docstring/signature checks per function.
 """
 
 from ._config import Config as _Config
+from ._diagnostic import Failures as _Failures
 from ._module import Function as _Function
 from ._module import Parent as _Parent
-from ._report import Failures as _Failures
 from ._report import check_function as _check_function
 
 

{docsig-0.90.3 → docsig-0.91.1}/docsig/_version.py

@@ -8,4 +8,4 @@ Allows for access to the version internally without cyclic imports
 caused by accessing it through __init__.
 """
 
-__version__ = "0.90.3"
+__version__ = "0.91.1"

{docsig-0.90.3 → docsig-0.91.1}/pyproject.toml

@@ -29,7 +29,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 requires-python = ">=3.10"
-version = "0.90.3"
+version = "0.91.1"
 
 [project.entry-points."flake8.extension"]
 SIG = "docsig.plugin:Flake8"
@@ -47,7 +47,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.90.3"
+current_version = "0.91.1"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -146,7 +146,7 @@ black = ">=24.4.2,<27.0.0"
 bump-my-version = ">=1.4.1,<1.5.0"
 deptry = ">=0.16.1,<0.26.0"
 flynt = "^1.0.1"
-gitpython = "^3.1.51"
+gitpython = "^3.1.52"
 isort = ">=5.13.2,<9.0.0"
 mypy = ">=2.3.0,<3.0"
 pre-commit = ">=3.3.3,<5.0.0"