Skip to main content

Check that all arguments are documented.

Project description


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.

Source Distribution

docargs-0.2.0.tar.gz (6.1 kB view hashes)

Uploaded source

Built Distribution

docargs-0.2.0-py3-none-any.whl (7.6 kB view hashes)

Uploaded py3

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