9275d1fc98f61d353a900c698d7b53592036803d

Author
Sagar Patil <sagar010797@gmail.com>
Committer
Robby Russell <robby@planetargon.com>
Date

Message

added README for pylint plugin (#7277)

Diff

 1diff --git a/plugins/pylint/README.md b/plugins/pylint/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..8c1de88babb8ca97e9d94263882816e12956176c
 4--- /dev/null
 5+++ b/plugins/pylint/README.md
 6@@ -0,0 +1,15 @@
 7+# pylint 
 8+
 9+This plugin adds code analysis for python through [Pylint](https://www.pylint.org/).
10+
11+To use it, add `pylint` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... pylint)
15+```
16+
17+## Aliases
18+
19+| Alias        | Command              | Description                                                                                                              |
20+| -------------| -------------------- | -------------------------------------------------------------------------------------------------------------------------|
21+| 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 |                                         |