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.
1 maintainer
Metadata
1 maintainer
Release files for docargs 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| docargs-0.2.0.tar.gz | 6.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docargs-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.7 kB
Release files / docargs-0.2.0.tar.gz
| Download URL | docargs-0.2.0.tar.gz |
|---|---|
| Size | 6.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4db4dcc9df4b7280b300f504409957fbc95831083d3863baa5755069ec6d193
|
|
BLAKE2b-256 checksum How to use checksums |
cf933e854648c6e9a52b08f3a008cc006c1622ce6a66718c1fb62fa3fa5040ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / docargs-0.2.0-py3-none-any.whl
| Download URL | docargs-0.2.0-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd85dbf620015acad24195319c2ecf7de4c647534a5ccad4990ae1d0012155d5
|
|
BLAKE2b-256 checksum How to use checksums |
4427b3cac257edff937cdd34b1d0a7c85ca2a8e6b658a6ea078834c0f1b22664
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for docargs 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
