pydocstyle
Verified for current stable LTS
Pydocstyle Commands
Pydocstyle command syntax with verified terminal examples.
Commands
7 commands for Pydocstyle
pydocstyle Operations
Pydocstyle Command: Analyze Python Script Or Directory
pydocstyle <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Check Errors From Specific Convention
pydocstyle --convention <pep257|numpy|google> <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Display Total Number Of Errors
pydocstyle --count <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Ignore Specific Errors
pydocstyle --ignore <D101,D2,D107,...> <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Show Debug Information
pydocstyle -d <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Show Error Explanations
pydocstyle -e <file.py|path/to/directory> pydocstyle Operations
Pydocstyle Command: Use Specific Configuration File
pydocstyle --config <path/to/config_file> <file.py|path/to/directory> Suggest a Pydocstyle Command
Submit missing workflows, corrections, or verified alternatives for this tool.
FAQ
Coverage: Focused examples for common Pydocstyle workflows.
Verified version: current stable LTS.
Verification: Test commands in a disposable workspace and submit notes for edge cases.