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-coverageIssues
To post issues, questions, and code, go to example-coverage Issues.
License
ansys-tools-example-coverage is licensed under the MIT license.
1 maintainer
Release files for ansys-tools-example-coverage 0.1.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 | |
|---|---|---|---|
| ansys-tools-example-coverage-0.1.0.tar.gz | 5.2 kB | Details |
Release files / ansys-tools-example-coverage-0.1.0.tar.gz
| Download URL | ansys-tools-example-coverage-0.1.0.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e9bcfa414f54e751702a63422514c007cd52218b00405ddb7d4cbeb68d310244
|
|
BLAKE2b-256 checksum How to use checksums |
53aea4867d297efafb669216dbdf4f8953fe5767ea1196ab27856ff33e27e400
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.0
|
