docsweeper 1.2.5

A linter for your Python code base that finds potentially outdated docstrings using version control.

Docsweeper is a linter for version controlled Python code bases that finds potentially outdated docstrings in your source files. For every code token in the file that has a docstring (see PEP 257), Docsweeper will interact with your Git or Mercurial version control system to determine:

1. in which revision the docstring has last been changed, and

2. how often the source code that is referenced by the docstring has been altered since that revision.

Used as a stand-alone application or as a plugin for the Flake8 linter, Docsweeper can be integrated into your code check-in or linting process easily and help you quickly determine which docstrings potentially contain obsolete information.

Compatibility

Docsweeper supports Linux, Mac, and Windows platforms that are compatible with Python 3.7 or newer. In addition to a working Python installation, you will also need at least one of the version control systems you intend to use Docsweeper with:

1. Git v1.7.0 or newer, and/or

2. Mercurial v5.2 or newer. This is the the first release of Mercurial with official support for Python 3.

Refer to the documentation for more information.