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.
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%
Install with:
pip install ansys-tools-example-coverage
To post issues, questions, and code, go to example-coverage Issues.
ansys-tools-example-coverage is licensed under the MIT license.