flake8-params

A flake8 plugin which checks for mismatches between function signatures and docstring params.

Docs
Tests
PyPI
Activity
QA
Other

Installation

flake8-params can be installed from PyPI.

To install with pip:

$ python -m pip install flake8-params

flake8 codes

Code	Description
PRM001	PRM001 Docstring parameters in wrong order.
PRM002	PRM002 Missing parameters in docstring.
PRM003	PRM003 Extra parameters in docstring.

Use as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

- repo: https://gitlab.com/pycqa/flake8rev: 3.8.1hooks:
- id: flake8additional_dependencies: [flake8-params==0.3.2]