https://github.com/ansys/example-coverage

Report on example coverage
https://github.com/ansys/example-coverage

Last synced: 7 months ago
JSON representation

Report on example coverage

• Host: GitHub
• URL: https://github.com/ansys/example-coverage
• Owner: ansys
• License: mit
• Created: 2021-08-04T22:40:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T16:25:07.000Z (over 1 year ago)
• Last Synced: 2025-06-19T17:57:16.733Z (7 months ago)
• Language: Python
• Size: 18.6 KB
• Stars: 3
• Watchers: 11
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
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:

.. code::

    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:

.. code::

   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.