A flake8 plugin which checks for mismatches between function signatures and docstring params.
Project description
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-paramsflake8 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]
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flake8_params-0.3.2.tar.gz.
File metadata
- Download URL: flake8_params-0.3.2.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
87558f81dd60ab5c168ee1faf23ee0416dbcaa0b2843aeca72eebeb2b4f6ca86
|
|
| MD5 |
2ac9bf96f63f57dd867c7e3cdb41649c
|
|
| BLAKE2b-256 |
d9725d49c19b01f03176d1f55f27fe6d51f634ea64ac2a3133a8dd9a2d8d68d3
|
File details
Details for the file flake8_params-0.3.2-py3-none-any.whl.
File metadata
- Download URL: flake8_params-0.3.2-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
122fca86128b42fbde712652567593d7ba34ae4a4d05bc48be174aebf7a5d007
|
|
| MD5 |
22902bd78505b192465d85b572da7cf5
|
|
| BLAKE2b-256 |
aa823cc9044c65f715255704ee14d38b956e2694e972925564fe947402da3aac
|
