aboutsummaryrefslogtreecommitdiff
path: root/.oh-my-zsh/plugins/pylint/README.md
diff options
context:
space:
mode:
Diffstat (limited to '.oh-my-zsh/plugins/pylint/README.md')
-rw-r--r--.oh-my-zsh/plugins/pylint/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/.oh-my-zsh/plugins/pylint/README.md b/.oh-my-zsh/plugins/pylint/README.md
new file mode 100644
index 0000000..8c1de88
--- /dev/null
+++ b/.oh-my-zsh/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 | |