numpydoc-linter 0.3.0

Numpydoclint is a linter for Numpy style docstrings.

Numpydoclint

Numpydoclint is a linter for Numpy style docstrings.

$ numpydoclint -vv asgard midgard/thor.py
asgard/loki.py:12 in function asgard.loki.mischief:
    GL03 Double line break found
asgard/odin.py:10 in type asgard.odin.Allfather:
    SA04 Missing description for See Also 'Yggdrasil' reference
midgard/thor.py:20 in function thor.Thor.strike:
    PR01 Parameters {'mjolnir'} not documented
Errors found in 3 out of 9 objects checked.

Numpydoclint uses static file analysis to identify code objects and then uses the numpydoc.validate module for validation, outputting corresponding error codes along with explanatory comments.

Installation

You can install Numpydoclint via the PIP package manager:

$ pip install numpydoc-linter

Alternatively, if you wish to install from the source code, follow these steps. Clone the repository and use Poetry to manage the project dependencies specified in pyproject.toml:

$ git clone https://github.com/nickuzmenkov/numpydoclint.git
$ cd numpydoclint
$ poetry install

Usage

Basic usage examples, as well as more advanced usage scenarios are covered in detail in the Official Documentation.