summaryrefslogtreecommitdiff
path: root/plugins/pylint
diff options
context:
space:
mode:
authorKozlov Alexander <badryke@gmail.com>2018-11-16 13:38:43 +0300
committerGitHub <noreply@github.com>2018-11-16 13:38:43 +0300
commit8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch)
treeee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/pylint
parentdd30cf104c9ca42d89d26a134382ca421869ce7e (diff)
parent3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff)
downloadzsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip
Merge branch 'master' into master
Diffstat (limited to 'plugins/pylint')
-rw-r--r--plugins/pylint/README.md15
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 | |