A Linter plugin to lint Python docstrings according to the semantics and conventions spec'd in PEP 257.
In use side-by-side with the flake8 linter:
-
Install python package pydocstyle, run:
pip install pydocstyle -
Install package, run:
apm install linter-pydocstyle
| Setting | Values |
|---|---|
| Error codes to ignore | Example: D100,D101 - all available error codes |
Path to executable pydocstyle cmd |
Default: pydocstyle |
If using python version management, like pyenv, the path configuration will need to be set. For pyenv, the path for pydocstyle is discoverable by executing:
pyenv which pydocstyle