Skip to main content

Check that all arguments are documented.

Project description

docargs

A package to check that you have documented all your parameters.

Docargs is written with continuous integration in mind: It will raise an error if you have not documented all your function arguments. It's easy to forget, but it's also important not to - so you should automate a test of it!

To use, simply pip install docargs, and run docargs mypackage/**/*py. Alternatively, docargs integrates with flake8, so running flake8 mypackage will also work.

To see it in action, check out the travis CI configuration on this repository

Currently, docargs only works with numpydoc-style docstrings.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for docargs, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size docargs-0.2.0-py3-none-any.whl (7.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size docargs-0.2.0.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page