pydocstyle

Check docstrings

$ pydocstyle [module.py]

$ pydocstyle [src/]

$ pydocstyle --convention [google] [module.py]

$ pydocstyle --ignore [D100,D101] [module.py]

$ pydocstyle --select [D200,D201] [module.py]

$ pydocstyle --source [module.py]

$ pydocstyle --count [module.py]

pydocstyle [--convention name] [--ignore codes] [--select codes] [options] files

pydocstyle checks Python docstring conventions. It enforces consistent documentation style.
Conventions define expected format. PEP 257, NumPy, and Google styles are supported.
Error codes identify specific issues. D100 series for modules, D200 for formatting, etc.
Source display shows problematic code. Helps identify and fix issues quickly.
Configuration files set project defaults. pyproject.toml and setup.cfg supported.

--convention NAME

Convention (pep257, numpy, google).

Errors to ignore.

Errors to check.

Show source code.

Explain errors.

Count only.

File pattern.

Config file.

pyproject.toml

Project configuration with a `[tool.pydocstyle]` section for convention, match patterns, and ignore/select rules.

Alternative project configuration with a `[pydocstyle]` section supporting the same options.

Standalone configuration file for pydocstyle settings.

pep257 - PEP 257 conventions
numpy - NumPy docstring style
google - Google Python style

Style preferences vary. May need tuning for project needs. Not all edge cases covered.

pydocstyle started as pep257 before expanding to support multiple conventions. It helps Python projects maintain consistent documentation.

pylint(1), flake8(1), mypy(1)