diagnostic.check-docs

This module serves as a command-line interface, making it easy to check that all error messages in a project are documented in the docs_index page.

Usage

Check that all the errors in the source code have a documentation entry.

usage: python -m diagnostic.check-docs [-h] [-v]
                                       [--fail-on-extra | --no-fail-on-extra]
                                       source error-index

Positional Arguments

source

Path to the source code file or directory.

error-index

Path to the documentation file or directory serving as the error index.

Named Arguments

-v, --verbose

Print detailed information about the codes discovered.

Default: False

--fail-on-extra, --no-fail-on-extra

Fail if there are codes in the documentation headings, that are not in the source code.

Default: True