Jump to >

Pydocstyle

pydocstyle is a static analysis tool to check your checks docstrings in your Python code against common docstring conventions.

Supported File Types

The following are supported by this tool:

  • Python: *.py

Installation

pydocstyle can be installed on most systems by running:

$ pip install pydocstyle

It may also be available in your system’s package manager.

Configuration

Pydocstyle Location

If the pydocstyle command is in a non-standard location, and can’t be found in Review Bot’s PATH environment variable, then you’ll need to specify the path in the Review Bot worker config file:

exe_paths = {
    'pydocstyle': '/path/to/pydocstyle',
}

You will need to restart the Review Bot worker after making this change.

Enabling pydocstyle in Review Board

First, you’ll need to add a Review Bot configuration in Review Board (see Tool Configurations).

The following configuration options are available:

Ignore (optional):

A comma-separated list of error or warning codes to ignore.

This is equivalent to flake8 --ignore=....

See the list of pydocstyle error codes for possible values.