summaryrefslogtreecommitdiff
path: root/plugins/pylint
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/pylint')
-rw-r--r--plugins/pylint/README.md7
-rw-r--r--plugins/pylint/pylint.plugin.zsh2
2 files changed, 4 insertions, 5 deletions
diff --git a/plugins/pylint/README.md b/plugins/pylint/README.md
index 8c1de88ba..31710d8a2 100644
--- a/plugins/pylint/README.md
+++ b/plugins/pylint/README.md
@@ -1,6 +1,7 @@
-# pylint
+# pylint
-This plugin adds code analysis for python through [Pylint](https://www.pylint.org/).
+This plugin adds aliases and autocompletion for [Pylint](https://www.pylint.org/),
+the Python code style checking tool.
To use it, add `pylint` to the plugins array in your zshrc file:
@@ -12,4 +13,4 @@ plugins=(... pylint)
| 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 | |
+| 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 |
diff --git a/plugins/pylint/pylint.plugin.zsh b/plugins/pylint/pylint.plugin.zsh
index 57c7c0ac5..14cea5bef 100644
--- a/plugins/pylint/pylint.plugin.zsh
+++ b/plugins/pylint/pylint.plugin.zsh
@@ -1,3 +1 @@
-# Aliases
alias pylint-quick='pylint --reports=n'
-compdef _pylint-quick pylint-quick='pylint --reports=n'