linter-pep257
A Linter plugin to lint Python docstrings according to the semantics and conventions spec'd in pep257.
Installation
-
If Linter is not already installed, follow the linter installation instructions.
-
Install python package pep257.
Execute in a terminal:
pip install pep257
- Install plugin.
Execute:
apm install linter-pep257
Configuration
| setting | values |
|---|---|
| Error codes to ignore (comma separated) | Example: D100,D101 - all available error codes |
| Path to executable pep257 cmd | Default: pep257 |
If using python version management, like pyenv, the path configuration will need to be set. For pyenv, the path for pep257 is discoverable by executing:
pyenv which pep257
Donation
