diff options
Diffstat (limited to 'plugins/pylint/README.md')
| -rw-r--r-- | plugins/pylint/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/pylint/README.md b/plugins/pylint/README.md new file mode 100644 index 000000000..8c1de88ba --- /dev/null +++ b/plugins/pylint/README.md @@ -0,0 +1,15 @@ +# pylint + +This plugin adds code analysis for python through [Pylint](https://www.pylint.org/). + +To use it, add `pylint` to the plugins array in your zshrc file: + +```zsh +plugins=(... pylint) +``` + +## Aliases + +| Alias | Command | Description | +| -------------| -------------------- | -------------------------------------------------------------------------------------------------------------------------| +| pylint-quick | `pylint --reports=n` | Displays a set of reports each one focusing on a particular aspect of the project, default set `no` for multiple reports | | |