added README for pylint plugin (#7277)

This commit is contained in:
Sagar Patil 2018-10-14 22:13:16 +05:30 committed by Robby Russell
parent f2d4b9768d
commit 9275d1fc98

15
plugins/pylint/README.md Normal file
View File

@ -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 | |