Metadata-Version: 2.1
Name: docargs
Version: 0.0.4
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.0.4.tar.gz
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](https://travis-ci.org/janfreyberg/superintendent)
        
        Currently, `docargs` only works with `numpydoc`-style docstrings. 
        
Keywords: linting
Platform: UNKNOWN
Description-Content-Type: text/markdown
