Usage

This library provides the Flake8 plugin flake8-params mismatches between function signatures and docstring params.

Flake8 codes

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

Pre-commit hook

flake8-params can also be used as a pre-commit hook See pre-commit for instructions

Sample .pre-commit-config.yaml:

- repo: https://github.com/pycqa/flake8
  rev: 3.8.4
  hooks:
  - id: flake8
    additional_dependencies:
    - flake8-params==0.0.0