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

Release history Release notifications | RSS feed

This version

0.2.0

May 3, 2020

0.1.1

Sep 29, 2019

0.1.0

Sep 27, 2019

0.0.9

Dec 15, 2018

0.0.8

Dec 15, 2018

0.0.7

Dec 5, 2018

0.0.6

Nov 30, 2018

0.0.5

Nov 25, 2018

0.0.5rc1 pre-release

Nov 25, 2018

0.0.4

Nov 9, 2018

0.0.3

Nov 5, 2018

0.0.2

Nov 5, 2018

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 details)

Uploaded May 3, 2020 Source

Built Distribution

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

Uploaded May 3, 2020 Python 3

File details

Details for the file docargs-0.2.0.tar.gz.

File metadata

Download URL: docargs-0.2.0.tar.gz
Upload date: May 3, 2020
Size: 6.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.1

File hashes

Hashes for docargs-0.2.0.tar.gz
Algorithm	Hash digest
SHA256	`a4db4dcc9df4b7280b300f504409957fbc95831083d3863baa5755069ec6d193`
MD5	`cfcad025dbb042d8bff1a3751d05ee69`
BLAKE2b-256	`cf933e854648c6e9a52b08f3a008cc006c1622ce6a66718c1fb62fa3fa5040ea`

See more details on using hashes here.

File details

Details for the file docargs-0.2.0-py3-none-any.whl.

File metadata

Download URL: docargs-0.2.0-py3-none-any.whl
Upload date: May 3, 2020
Size: 7.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.1

File hashes

Hashes for docargs-0.2.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`bd85dbf620015acad24195319c2ecf7de4c647534a5ccad4990ae1d0012155d5`
MD5	`d9c50391eef90ddeeb74b1cac169ba6b`
BLAKE2b-256	`4427b3cac257edff937cdd34b1d0a7c85ca2a8e6b658a6ea078834c0f1b22664`