CmdID

CmdID / Commands

pydocstyle

Statically check Python scripts for compliance with Python docstring conventions. tldr-pages

On several platforms

Opens CmdID with your command. It is read in your browser and sent nowhere.

Several platforms

from tldr-pages, CC BY 4.0

Analyze a Python script or all the Python scripts in a specific directory

pydocstyle file.pyIdentify

Show an explanation of each error

pydocstyle --explain file.pyIdentify

Show debug information

pydocstyle --debug file.pyIdentify

Display the total number of errors

pydocstyle --count file.pyIdentify

Use a specific configuration file

pydocstyle --config path/to/config_file file.pyIdentify

Ignore one or more errors

pydocstyle --ignore D101,D2,D107,... file.pyIdentify

Check for errors from a specific convention

pydocstyle --convention pep257 file.pyIdentify