2024-03-31 13:18:40 +01:00
|
|
|
# pydocstyle
|
|
|
|
|
|
|
|
|
|
> Statically check Python scripts for compliance with Python docstring conventions.
|
|
|
|
|
> More information: <https://www.pydocstyle.org/en/latest/>.
|
|
|
|
|
|
|
|
|
|
- Analyze a Python script or all the Python scripts in a specific directory:
|
|
|
|
|
|
|
|
|
|
`pydocstyle {{file.py|path/to/directory}}`
|
|
|
|
|
|
2024-06-12 06:43:11 +01:00
|
|
|
- Show an explanation of each error:
|
2024-03-31 13:18:40 +01:00
|
|
|
|
|
|
|
|
`pydocstyle {{-e|--explain}} {{file.py|path/to/directory}}`
|
|
|
|
|
|
2024-06-12 06:43:11 +01:00
|
|
|
- Show debug information:
|
2024-03-31 13:18:40 +01:00
|
|
|
|
|
|
|
|
`pydocstyle {{-d|--debug}} {{file.py|path/to/directory}}`
|
|
|
|
|
|
|
|
|
|
- Display the total number of errors:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --count {{file.py|path/to/directory}}`
|
|
|
|
|
|
|
|
|
|
- Use a specific configuration file:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --config {{path/to/config_file}} {{file.py|path/to/directory}}`
|
|
|
|
|
|
|
|
|
|
- Ignore one or more errors:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --ignore {{D101,D2,D107,...}} {{file.py|path/to/directory}}`
|
|
|
|
|
|
|
|
|
|
- Check for errors from a specific convention:
|
|
|
|
|
|
|
|
|
|
`pydocstyle --convention {{pep257|numpy|google}} {{file.py|path/to/directory}}`
|
