docstringtest
docstringtest is a small package for regression testing of docstrings in Python code. It checks that all appropriate methods and functions are using ReST docstrings with parameter information so that nice documentation can be generated. This format looks like:
def example_function(varA,varB):
"""
This function does nothing
:param varA: The first variable
:param varB: The second variable
:type varA: The type of the first variable
:type varB: The type of the second variable
"""
passIt makes it easy to check that the docstrings match with the current parameters so that documentation doesn’t become out-of-step with the code.
If you wanted to add docstringtest to a standard test algorithm, it would simply be something like this
import mymodule
import docstringtest
def test_docstringtest():
docstringtest.testModule(mymodule)Installation
You can install “docstringtest” via pip from PyPI:
$ pip install docstringtest
Contributing
Contributions are very welcome.
License
Distributed under the terms of the MIT license, “docstringtest” is free and open source software
Issues
If you encounter any problems, please file an issue along with a detailed description.
1 maintainer
Metadata
1 maintainer
Release files for docstringtest 0.3.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 | Actions |
|---|---|---|---|---|
| docstringtest-0.3.0.tar.gz | 4.4 kB | Without provenance | Details for docstringtest-0.3.0.tar.gz |
Release files / docstringtest-0.3.0.tar.gz
| Download URL | docstringtest-0.3.0.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0c762d1157f6c7a21419c8c7bc3453035ebed9c40472b6adf8505f16fc21c8a7
|
|
BLAKE2b-256 checksum How to use checksums |
25e22cdaa8fa607f79ec0bff9741ce8e26822843533bcac45e3c3f80d9b5ed8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for docstringtest 0.3.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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
