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 git+https://github.com/janfreyberg/docargs.git, and run
docargs <packagename>.
docargs will import your package, so if there are side effects on import,
those will occur. To see it in action, check out the travis CI configuration
on the superintendent package
Currently, docargs only works with numpydoc-style docstrings.
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.
