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] path
Check docstring matches signature
positional arguments:
path directory or file to check
optional arguments:
-h, --help show this help message and exit
-v, --version show version and exit
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.5.0.tar.gz
(9.4 kB
view hashes)
Built Distribution
docsig-0.5.0-py3-none-any.whl
(11.4 kB
view hashes)