Metadata-Version: 2.1
Name: docargs
Version: 0.1.1
Summary: Check that all arguments are documented.
Home-page: https://github.com/janfreyberg/docargs
Author: Jan Freyberg
Author-email: jan@asidatascience.com
License: UNKNOWN
Download-URL: https://github.com/janfreyberg/docargs/0.1.1.tar.gz
Keywords: linting
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: numpydoc
Requires-Dist: click
Requires-Dist: colorama
Requires-Dist: pyyaml
Requires-Dist: flake8
Requires-Dist: docstring-parser
Provides-Extra: tests
Requires-Dist: mypy ; extra == 'tests'

# 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](https://travis-ci.org/janfreyberg/docargs)

Currently, `docargs` only works with `numpydoc`-style docstrings. 


