diff options
| author | Sagar Patil <sagar010797@gmail.com> | 2018-10-14 22:13:16 +0530 |
|---|---|---|
| committer | Robby Russell <robby@planetargon.com> | 2018-10-14 09:43:16 -0700 |
| commit | 9275d1fc98f61d353a900c698d7b53592036803d (patch) | |
| tree | 9e58743f135d45d069f9b85817956a552c482f68 /plugins/pylint | |
| parent | f2d4b9768d75499c772cc656f574228c61f28b66 (diff) | |
| download | zsh-9275d1fc98f61d353a900c698d7b53592036803d.tar.gz zsh-9275d1fc98f61d353a900c698d7b53592036803d.tar.bz2 zsh-9275d1fc98f61d353a900c698d7b53592036803d.zip | |
added README for pylint plugin (#7277)
Diffstat (limited to 'plugins/pylint')
| -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 | | |