omz

1 files changed, 16 insertions, 0 deletions

diff --git a/home/.oh-my-zsh/plugins/pylint/README.md b/home/.oh-my-zsh/plugins/pylint/README.md
new file mode 100644
index 0000000..31710d8
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/pylint/README.md
@@ -0,0 +1,16 @@
+# pylint
+
+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:
+
+```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 |