docsig 0.16.0

Check signature params for proper documentation

Check signature params for proper documentation

Currently only supports reStructuredText (Sphinx)

Installation

$ pip install docsig

Usage

Commandline

usage: docsig [-h] [-v] [-s STR] [-d LIST] [-t LIST] [path [path ...]]

Check docstring matches signature

positional arguments:
  path                     directories or files to check (default: .)

optional arguments:
  -h, --help               show this help message and exit
  -v, --version            show version and exit
  -s STR, --string STR     string to parse instead of files
  -d LIST, --disable LIST  comma separated list of rules to disable
  -t LIST, --target LIST   comma separated list of rules to target

Options can also be configured with the pyproject.toml file

[tool.docsig]
disable = [
    "E101",
    "E102",
    "E103",
]
target = [
    "E102",
    "E103",
    "E104",
]

API

>>> from docsig import docsig

>>> string = """
... def function(param1, param2, param3) -> None:
...     '''Summary for passing docstring...
...
...     Explanation for passing docstring...
...
...     :param param1: About param1.
...     :param param2: About param2.
...     :param param3: About param3.
...     '''
...     """
>>> docsig(string=string)
0

>>> string = """
... def function(param1, param2) -> None:
...     '''Summary for failing docstring...
...
...     Explanation for failing docstring...
...
...     :param param1: About param1.
...     :param param2: About param2.
...     :param param3: About param3.
...     '''
... """
>>> docsig(string=string)
2
-
def function(✓param1, ✓param2, ✖None) -> ✓None:
    """...
<BLANKLINE>
    :param param1: ✓
    :param param2: ✓
    :param param3: ✖
    """
<BLANKLINE>
E102: includes parameters that do not exist
<BLANKLINE>
1

There are currently 9 other errors