docsig 0.53.2__tar.gz → 0.53.3__tar.gz

{docsig-0.53.2 → docsig-0.53.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.53.2
+Version: 0.53.3
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -222,7 +222,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.53.2
+        rev: v0.53.3
         hooks:
           - id: docsig
             args:

{docsig-0.53.2 → docsig-0.53.3}/README.rst

@@ -194,7 +194,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.53.2
+        rev: v0.53.3
         hooks:
           - id: docsig
             args:

{docsig-0.53.2 → docsig-0.53.3}/docsig/_report.py

@@ -83,11 +83,38 @@ class Failure(_t.List[str]):
                 doc = func.docstring.args.get(index)
                 self._description_syntax(doc)
                 self._indent_syntax(doc)
-                self._incorrect(doc)
-                if arg != doc:
-                    self._order(arg, doc)
-                    self._misspelled(arg, doc)
-                    self._not_equal(arg, doc)
+
+                if doc.name == _UNNAMED:
+                    # if the parameter does not have a name, but exists,
+                    # then it must be incorrectly documented
+                    # prior implementation relied on the docstring
+                    # parameter equalling the signature parameter
+                    self._add(_E[107])
+
+                elif arg != doc:
+                    if any(
+                        arg.name == i.name for i in self._func.docstring.args
+                    ) or any(
+                        doc.name == i.name for i in self._func.signature.args
+                    ):
+                        # parameters out of order
+                        self._add(_E[101])
+
+                    elif (
+                        arg.name is not None
+                        and doc.name is not None
+                        and not self._errors
+                        and _almost_equal(
+                            arg.name, doc.name, _MIN_MATCH, _MAX_MATCH
+                        )
+                    ):
+                        # spelling error found in documented parameter
+                        self._add(_E[112])
+
+                    elif arg.name is not None and doc.name is not None:
+                        # documented parameter not equal to its
+                        # respective argument
+                        self._add(_E[110])
 
         self.sort()
 
@@ -103,12 +130,6 @@ class Failure(_t.List[str]):
         if value not in self._disable and message not in self:
             super().append(message)
 
-    def _order(self, sig: _Param, doc: _Param) -> None:
-        if any(sig.name == i.name for i in self._func.docstring.args) or any(
-            doc.name == i.name for i in self._func.signature.args
-        ):
-            self._add(_E[101])
-
     def _exists(self) -> None:
         # pop the parameters that do not exist so that they are excluded
         # from further analysis, that way there are no additional, and
@@ -185,32 +206,10 @@ class Failure(_t.List[str]):
 
             self._add(_E[105], hint=hint)
 
-    def _incorrect(self, doc: _Param) -> None:
-        # if the parameter does not have a name, but exists, then it
-        # must be incorrectly documented
-        # prior implementation relied on the docstring parameter
-        # equalling the signature parameter
-        if doc.name == _UNNAMED:
-            self._add(_E[107])
-
-    # final catch-all
-    def _not_equal(self, sig: _Param, doc: _Param) -> None:
-        if sig.name is not None and doc.name is not None and not self._errors:
-            self._add(_E[110])
-
     def _class_return(self) -> None:
         if self._func.docstring.returns and self._func.isinit:
             self._add(_E[111], hint=True)
 
-    def _misspelled(self, sig: _Param, doc: _Param) -> None:
-        if (
-            sig.name is not None
-            and doc.name is not None
-            and not self._errors
-            and _almost_equal(sig.name, doc.name, _MIN_MATCH, _MAX_MATCH)
-        ):
-            self._add(_E[112])
-
     def _description_syntax(self, doc: _Param) -> None:
         if doc.description is not None and not doc.description.startswith(" "):
             self._add(_E[115])

{docsig-0.53.2 → docsig-0.53.3}/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.53.2"
+__version__ = "0.53.3"

{docsig-0.53.2 → docsig-0.53.3}/pyproject.toml

@@ -5,15 +5,6 @@ requires = [
 ]
 
 [tool.black]
-exclude = '''
-/(
-  | \.git
-  | \.mypy_cache
-  | _build
-  | build
-  | dist
-)/
-'''
 line-length = 79
 
 [tool.codespell]
@@ -32,10 +23,21 @@ omit = [
   "whitelist.py"
 ]
 
+[tool.deptry.per_rule_ignores]
+DEP004 = ["yaml"]
+
+[tool.docformatter]
+in-place = true
+wrap-summaries = 72
+
 [tool.docsig]
 check-class = true
 check-protected-class-methods = true
 
+[tool.flynt]
+line-length = 79
+transform-concats = true
+
 [tool.isort]
 ensure_newline_before_comments = true
 force_grid_wrap = 0
@@ -45,6 +47,14 @@ multi_line_output = 3
 profile = "black"
 use_parentheses = true
 
+[tool.mypy]
+exclude = [
+  "whitelist\\.py"
+]
+ignore_missing_imports = true
+install_types = true
+non_interactive = true
+
 [tool.poetry]
 authors = [
   "jshwi <stephen@jshwisolutions.com>"
@@ -66,7 +76,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.53.2"
+version = "0.53.3"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"
@@ -76,57 +86,62 @@ click = "^8.1.7"
 pathspec = "^0.12.1"
 python = "^3.8"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
+black = "^24.4.2"
 bump2version = "^1.0.1"
 deptry = "^0.16.1"
+docformatter = "^1.7.5"
+flynt = "^1.0.1"
+isort = "^5.13.2"
+mypy = "^1.10.0"
+pre-commit = "^3.3.3"
+pylint = "^3.1.0"
+tox = "^4.15.0"
+vulture = "^2.11"
+
+[tool.poetry.group.docs.dependencies]
 furo = "^2024.4.27"
-ipython = "^8.12.0"
 myst-parser = "^3.0.1"
-pre-commit = "^3.3.3"
-pyaud = "^7.5.0"
-pytest-randomly = "^3.13.0"
+pytest = "^8.2.0"
+pyyaml = "^6.0.1"
+sphinx-copybutton = "^0.5.2"
+sphinx-markdown-builder = ">=0.5.5,<0.7.0"
+templatest = "^0.10.1"
+
+[tool.poetry.group.tests.dependencies]
+pytest = "^8.2.0"
+pytest-benchmark = "^4.0.0"
+pytest-cov = "^5.0.0"
+pytest-randomly = "^3.15.0"
 pytest-sugar = "^1.0.0"
 pytest-xdist = "^3.6.1"
-restview = "^3.0.0"
-sphinx-copybutton = "^0.5.2"
-sphinx-toolbox = "^3.5.0"
 templatest = "^0.10.1"
-tox = "^4.15.0"
 
 [tool.poetry.scripts]
 docsig = "docsig.__main__:main"
 
-[tool.pyaud]
-audit = [
-  "commit-policy",
-  "copyright-year",
-  "format",
-  "format-docs",
-  "format-str",
-  "imports",
-  "lint",
-  "test",
-  "typecheck",
-  "unused",
-  "whitelist"
+[tool.pylint.options]
+disable = [
+  "consider-using-f-string",
+  "fixme"
 ]
-exclude = '''
-(?x)^(
-  | docs\/conf\.py
-  | whitelist\.py
-  | scripts\/.*
-)$
-'''
+ignore-patterns = [
+  'conf\.py',
+  'whitelist\.py'
+]
+min-similarity-lines = 9
 
 [tool.pytest.ini_options]
 addopts = [
   "--color=yes",
   "--cov-report=term-missing",
   "--durations=5",
-  "-n=auto",
   "-vv"
 ]
 filterwarnings = "ignore::DeprecationWarning"
+markers = [
+  "benchmark: Marks tests as benchmarks"
+]
 norecursedirs = [
   ".git",
   ".idea",