浏览代码

added README for pylint plugin (#7277)

Sagar Patil 5 年之前
父节点
当前提交
9275d1fc98
共有 1 个文件被更改,包括 15 次插入0 次删除
  1. 15 0
      plugins/pylint/README.md

+ 15 - 0
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 |                                         |