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/flake8
rev: 3.8.1
hooks:
- id: flake8
additional_dependencies: [flake8-params==0.3.2]
Release files for flake8-params 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flake8_params-0.3.2.tar.gz | 6.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flake8_params-0.3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.8 kB
Release files / flake8_params-0.3.2.tar.gz
| Download URL | flake8_params-0.3.2.tar.gz |
|---|---|
| Size | 6.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
87558f81dd60ab5c168ee1faf23ee0416dbcaa0b2843aeca72eebeb2b4f6ca86
|
|
BLAKE2b-256 checksum How to use checksums |
d9725d49c19b01f03176d1f55f27fe6d51f634ea64ac2a3133a8dd9a2d8d68d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / flake8_params-0.3.2-py3-none-any.whl
| Download URL | flake8_params-0.3.2-py3-none-any.whl |
|---|---|
| Size | 6.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
122fca86128b42fbde712652567593d7ba34ae4a4d05bc48be174aebf7a5d007
|
|
BLAKE2b-256 checksum How to use checksums |
aa823cc9044c65f715255704ee14d38b956e2694e972925564fe947402da3aac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|