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
Close
Hashes for ansys-tools-example-coverage-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9bcfa414f54e751702a63422514c007cd52218b00405ddb7d4cbeb68d310244 |
|
MD5 | 013a2a0101f1b1b92da521223bdfb6b4 |
|
BLAKE2b-256 | 53aea4867d297efafb669216dbdf4f8953fe5767ea1196ab27856ff33e27e400 |