https://github.com/janfreyberg/docargs

Check arguments and docstrings
https://github.com/janfreyberg/docargs

Last synced: 3 months ago
JSON representation

Check arguments and docstrings

• Host: GitHub
• URL: https://github.com/janfreyberg/docargs
• Owner: janfreyberg
• License: mit
• Created: 2018-05-30T19:00:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-03T12:34:37.000Z (over 4 years ago)
• Last Synced: 2024-10-04T09:27:02.029Z (3 months ago)
• Language: Python
• Homepage: http://www.janfreyberg.com/docargs
• Size: 5.56 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.