Tools to assess the docstring examples coverage.
Project description
ansys-tools-example-coverage
The ansys-tools-example-coverage library is intended to assess and report the docstring examples coverage of modules and submoldules from a given directory. example-coverage is licensed under the MIT License.
What does this library do?
ansys-tools-example-coverage displays the number of documentation strings containing examples following either the numpydoc or Google-Style.
Example usage:
python -m ansys.tools.example_coverage -f "path_to_package"
Name Methods Missed Covered
-----------------------------------------------------------------------
my_package.my_module_a.sub_module_a 3 3 0.0%
my_package.my_module_a.sub_module_b 6 3 50.0%
my_package.my_module_a.sub_module_c 1 0 100.0%
my_package.my_module_b 4 1 75.0%
-----------------------------------------------------------------------
Total 14 7 50%
Installation
Install with:
pip install ansys-tools-example-coverage
Issues
To post issues, questions, and code, go to example-coverage Issues.
License
ansys-tools-example-coverage is licensed under the MIT license.
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
Close
Hashes for ansys-tools-example-coverage-0.1.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c2af046196de8387240d9178732a3e0886f1b3189dddaba58f4ab96e0c74ac7 |
|
MD5 | d3cedd4ac5872eeebf41ca14bd5fb07d |
|
BLAKE2b-256 | a80f48526019ece0f4e4cf277d2aded29db1c9e224cdfffd146530fa7a4ff392 |
Close
Hashes for ansys_tools_example_coverage-0.1.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7919beac5b3ba3ca11eb7d5133b454dd5eda2c195819783a492d321b02b4206f |
|
MD5 | 06ff7c993d5da92ee48d46a4df58181e |
|
BLAKE2b-256 | 07d1f0739e84c42f5a0b51da7a1b30f7cc6b3a99546be3e2e6bd6b538821ab1b |