|
1 | | -# Docstr-Coverage |
2 | | - |
3 | | -[](https://github.com/psf/black) |
4 | | - |
5 | | -If the health of your documentation is in dire straits, `docstr-coverage` will see you now. |
| 1 | + |
| 2 | +<!--- |
| 3 | +TODO After review, replace the line above with this one (will only work after merge) |
| 4 | + |
| 5 | +--> |
| 6 | + |
| 7 | + |
| 8 | +<p align="center"> |
| 9 | + <a href="https://choosealicense.com/licenses/mit/" alt="License: MIT"> |
| 10 | + <img src="https://img.shields.io/badge/license-MIT-green.svg" /></a> |
| 11 | + <img src="https://github.com/HunterMcGushion/docstr_coverage/workflows/Python%20package/badge.svg" /> |
| 12 | + <a href='https://docstr-coverage.readthedocs.io/en/latest/?badge=latest'> |
| 13 | + <img src='https://readthedocs.org/projects/docstr-coverage/badge/?version=latest' alt='Documentation Status' /> |
| 14 | + </a> |
| 15 | + <a href="https://pypi.org/project/docstr-coverage/"> |
| 16 | + <img alt="PyPI" src="https://img.shields.io/pypi/v/docstr-coverage"> |
| 17 | + </a> |
| 18 | + <a href="https://img.shields.io/pypi/pyversions/docstr-coverage"> |
| 19 | + <img alt="Python Version" src="https://img.shields.io/pypi/pyversions/docstr-coverage"> |
| 20 | + </a> |
| 21 | + <a href="https://pepy.tech/project/docstr-coverage"> |
| 22 | + <img alt="Download count" src="https://static.pepy.tech/personalized-badge/docstr-coverage?period=total&units=international_system&left_color=gray&right_color=orange&left_text=downloads"> |
| 23 | + </a> |
| 24 | + <a href="https://black.readthedocs.io/en/stable/" alt="Code Style: Black"> |
| 25 | + <img src="https://img.shields.io/badge/code%20style-black-000000.svg" /> |
| 26 | + </a> |
| 27 | +</p> |
6 | 28 |
|
7 | 29 | `docstr-coverage` is a simple tool that lets you measure your Python source code's |
8 | | -[docstring](http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring) coverage. It can show you which of your functions, |
9 | | -classes, methods, and modules don't have docstrings. It also provide statistics about overall docstring coverage for individual |
10 | | -files, and for your entire project. |
| 30 | +[docstring](http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring) coverage. |
| 31 | +It shows which of your functions, classes, methods, and modules don't have docstrings. |
| 32 | +It also provide statistics about overall docstring coverage for individual files, and for your entire project. |
11 | 33 |
|
12 | 34 | - [Source](https://github.com/HunterMcGushion/docstr_coverage) |
13 | 35 | - [Documentation](https://docstr-coverage.readthedocs.io/en/latest/api_essentials.html) |
|
0 commit comments