diff options
Diffstat (limited to 'plugins/pylint')
-rw-r--r-- | plugins/pylint/README.md | 15 | ||||
-rw-r--r-- | plugins/pylint/pylint.plugin.zsh | 4 |
2 files changed, 17 insertions, 2 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 | | diff --git a/plugins/pylint/pylint.plugin.zsh b/plugins/pylint/pylint.plugin.zsh index 6760c67b0..57c7c0ac5 100644 --- a/plugins/pylint/pylint.plugin.zsh +++ b/plugins/pylint/pylint.plugin.zsh @@ -1,3 +1,3 @@ # Aliases -alias pylint-quick='pylint --reports=n --include-ids=y' -compdef _pylint-quick pylint-quick='pylint --reports=n --include-ids=y'
\ No newline at end of file +alias pylint-quick='pylint --reports=n' +compdef _pylint-quick pylint-quick='pylint --reports=n' |