linter-pep257

Lint Python docstrings on the fly.

Usage no npm install needed!

<script type="module">
  import linterPep257 from 'https://cdn.skypack.dev/linter-pep257';
</script>

README

linter-pep257

A Linter plugin to lint Python docstrings according to the semantics and conventions spec'd in pep257.

Installation

  1. If Linter is not already installed, follow the linter installation instructions.

  2. Install python package pep257.

Execute in a terminal:

pip install pep257
  1. 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

Share the love!

donate-paypal

Donate Bitcoins