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
1 Oct 20, 2021
1 Jan 31, 2022
1.5k Jan 06, 2023
2 Dec 02, 2021
0 Dec 13, 2022
3 Apr 03, 2022
460 Dec 23, 2022
64 Sep 18, 2022
651 Dec 27, 2022
3 Sep 21, 2022
0 Oct 10, 2021
0 Oct 29, 2022
1 Jan 19, 2022
1.1k Dec 30, 2022
166 Jan 04, 2023
266 Jan 02, 2023
49 Jan 09, 2023
249 Dec 22, 2022
12.3k Jan 04, 2023