Skip to main content

Check signature params for proper documentation

Project description

License pypi CI codecov.io readthedocs.org python3.8 black

Check signature params for proper documentation

Installation

$ pip install docsig

Usage

Commandline

usage: docsig [-h] [-c INT] [-l INT] [-s STR] [-i LIST] [-I LIST]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.1.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

docsig-0.1.0-py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page