docov
Light-weight, recursive docstring coverage analysis for python modules.
Overview
docov provides light-weight docstring coverage analysis for python modules. It recursively collects symbols defined by the specified module and checks whether these symbols have docstrings and if they are longer than at least 20 symbols.
Installation
docov is available via PyPI:
$ pip install docov
Usage
Once installed, docov can be used from the command-line
$ docov <module-name>
which will produce a badge and a report on symbols, which were deemed to have insufficient docstring.
A short help text on available options can be found with
$ docov -h
usage: docov [-h] [-o OUTPUT] [-d DEPTH] [--no-badge] [--no-report] MODULE
Command line utility to analyze docstring coverage of python modules.
Works by recursively fetching the module's symbol's docstrings and
checking that hey are non-empty and consist of at least 20 characters.
Generates a badge and a report if not specified otherwise.
positional arguments:
MODULE The module which is to be analyzed.
optional arguments:
-h, --help show this help message and exit
-o OUTPUT, --output OUTPUT
Output directory.
-d DEPTH, --depth DEPTH
Analysis recursion depth.
--no-badge Generate a badge in <output>/docov.svg.
--no-report Generate a report in <output>/docov.txt.
15 Dec 7, 2022
1 Nov 8, 2021
7 Mar 19, 2022
1 Jan 6, 2022
3 Mar 2, 2022
0 Feb 14, 2022
4 Dec 31, 2022
831 Dec 27, 2022
1.4k Jan 7, 2023
20.3k Jan 09, 2023
435 Dec 29, 2022
361 Nov 16, 2022
1 Jan 22, 2022
0 Oct 10, 2021
12 Nov 16, 2022
2 Jan 15, 2022
4.1k Jan 06, 2023
6 Jan 07, 2023
2 Feb 12, 2022
71 Oct 28, 2022
14 Dec 18, 2022
2 Nov 05, 2021
0 Sep 05, 2021
59 Nov 11, 2022
6 Mar 31, 2022
17 Aug 01, 2022
1.2k Dec 30, 2022
470 Dec 28, 2022