Test if doctype types match signatures
Project description
pydoctest: docstring signature verification
File issues here: Issues tracker
Motivation
Pydoctest helps you verify that your docstrings match your function signatures. As a codebase evolves, you can some times forget to update the docstrings.
Installation
Install pydoctest with pip:
$ python3 -m pip install pydoctest
Usage
Navigate to your project location, and execute pydoctest
$ pydoctest
Output
Pydoctest supports outputting results either as JSON
or Text
with different verbosity options. By default, Text
is returned. To specify the output, invoke with --reporter
argument:
$ pydoctest --reporter [json | text]
For Text-output, --verbosity
can be provided with a value of 0 (quiet), 1 (show failed) or 2 (show all).
$ pydoctest --reporter text --verbosity 1
Configuration
Pydoctest can be configured with a config JSON file. By default, it will search for pydoctest.json
in the directory pydoctest is executed. A path can also be provided when executing:
$ pydoctest --config /path/to/pydoctest.json
Example pydoctest.json:
{
"include_paths": [ "server/*.py" ],
"fail_on_missing_docstring": true,
"parser": "google",
}
Docstring format can be specified with the --parser
argument:
$ pydoctest --parser google
Currently, only google is supported.
License
Pydoctest is licensed under the terms of the MIT License (see the LICENSE file).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pydoctest-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de8fdeafd9346cc89519a97c6815eb583890492300a1ba766f108cfc09ccb436 |
|
MD5 | 4070851b882607df4f2518307c891422 |
|
BLAKE2b-256 | 51152293f506e9e81ca53824283d56a7ac8708af52730eb5c01d56427652a56c |