docsig 0.12.0

Check signature params for proper documentation

Check signature params for proper documentation

Currently only supports reStructuredText (Sphinx)

Installation

$ pip install docsig

Error Codes

Usage

Commandline

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

Check docstring matches signature

positional arguments:
  path                     directories or files to check

optional arguments:
  -h, --help               show this help message and exit
  -v, --version            show version and exit
  -d LIST, --disable LIST  comma separated list of rules to disable

Options can also be configured with the pyproject.toml file

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