docsig 0.65.0__tar.gz → 0.66.1__tar.gz

{docsig-0.65.0 → docsig-0.66.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.65.0
+Version: 0.66.1
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -181,7 +181,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.65.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.66.1, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -270,7 +270,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.65.0
+        rev: v0.66.1
         hooks:
           - id: docsig
             args:
@@ -289,7 +289,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.65.0
+              - docsig==0.66.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.65.0 → docsig-0.66.1}/README.rst

@@ -153,7 +153,7 @@ ensure your installation has registered `docsig`
 .. code-block:: console
 
     $ flake8 --version
-    7.1.0 (docsig: 0.65.0, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
+    7.1.0 (docsig: 0.66.1, mccabe: 0.7.0, pycodestyle: 2.12.0, pyflakes: 3.2.0) CPython 3.8.13 on Darwin
 
 And now use `flake8` to lint your files
 
@@ -242,7 +242,7 @@ Standalone
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.65.0
+        rev: v0.66.1
         hooks:
           - id: docsig
             args:
@@ -261,7 +261,7 @@ or integrated with ``flake8``
         hooks:
           - id: flake8
             additional_dependencies:
-              - docsig==0.65.0
+              - docsig==0.66.1
             args:
               - "--sig-check-class"
               - "--sig-check-dunders"

{docsig-0.65.0 → docsig-0.66.1}/docsig/_module.py

@@ -233,9 +233,10 @@ class Function(Parent):
         name = self._imports.get(name, name)
         if self._decorators is not None:
             for dec in self._decorators.nodes:
-                return (isinstance(dec, _ast.Name) and dec.name == name) or (
+                if (isinstance(dec, _ast.Name) and dec.name == name) or (
                     isinstance(dec, _ast.Attribute) and dec.attrname == name
-                )
+                ):
+                    return True
 
         return False
 

{docsig-0.65.0 → docsig-0.66.1}/docsig/_report.py

@@ -180,6 +180,13 @@ class Failure(_t.List[Failed]):
         elif doc.name == _UNNAMED:
             # param-incorrectly-documented
             self._add(_E[303])
+        elif doc.closing_token != ":":
+            # bad-closing-token
+            self._add(
+                _E[304],
+                token=doc.closing_token,
+                hint=True,
+            )
 
     def _sig4xx_parameters(self, doc: _Param, sig: _Param) -> None:
         if doc.indent > 0:

{docsig-0.65.0 → docsig-0.66.1}/docsig/_stub.py

@@ -84,6 +84,7 @@ class Param(_t.NamedTuple):
     name: str | None = None
     description: str | None = None
     indent: int = 0
+    closing_token: str = ":"
 
     def __eq__(self, other: object) -> bool:
         if not isinstance(other, Param):
@@ -314,7 +315,9 @@ class Docstring(_Stub):
         string = cls._normalize_docstring(node.value)
         returns = bool(_re.search(r":returns?:", string))
         docstring = cls(string, returns)
-        for match in _re.findall(r":(.*?):((?:.|\n)*?)(?=\n:|$)", string):
+        for match in _re.findall(
+            r":(.*?)([^\w\s])((?:.|\n)*?)(?=\n:|$)", string
+        ):
             if match:
                 kinds = match[0].split()
                 if kinds:
@@ -322,8 +325,9 @@ class Docstring(_Stub):
                         Param(
                             DocType.from_str(kinds[0]),
                             UNNAMED if len(kinds) == 1 else kinds[1],
-                            match[1] or None,
+                            match[2] or None,
                             int(indent_anomaly),
+                            match[1],
                         )
                     )
 

{docsig-0.65.0 → docsig-0.66.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.65.0"
+__version__ = "0.66.1"

{docsig-0.65.0 → docsig-0.66.1}/docsig/messages.py

@@ -187,6 +187,13 @@ E = MessageMap(
             "parameter appears to be incorrectly documented",
             "param-incorrectly-documented",
         ),
+        304: Message(
+            "SIG304",
+            "SIG304",
+            "bad token used to close parameter declaration '{token}'",
+            "bad-closing-token",
+            "close a parameter declaration with ':'",
+        ),
         #: SIG4xx Description
         401: Message(
             "SIG401",

{docsig-0.65.0 → docsig-0.66.1}/pyproject.toml

@@ -11,7 +11,7 @@ line-length = 79
 allow_dirty = true
 commit = true
 commit_args = "-sS"
-current_version = "0.65.0"
+current_version = "0.66.1"
 message = "bump: version {current_version} → {new_version}"
 sign_tags = true
 tag = true
@@ -131,7 +131,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.65.0"
+version = "0.66.1"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
@@ -143,7 +143,7 @@ wcmatch = ">=8.5.2,<11.0.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
-bump-my-version = ">=0.24.1,<0.27.0"
+bump-my-version = ">=0.24.1,<0.30.0"
 deptry = ">=0.16.1,<0.21.0"
 docformatter = "^1.7.5"
 flynt = "^1.0.1"