Check signature params for proper documentation
Project description
Check signature params for proper documentation
Currently only supports reStructuredText (Sphinx)
Installation
$ pip install docsig
Usage
Commandline
usage: docsig [-h] [-v] [-d LIST] [-t 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
-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",
]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docsig-0.13.0.tar.gz
(12.0 kB
view hashes)
Built Distribution
docsig-0.13.0-py3-none-any.whl
(14.0 kB
view hashes)