Browse Source

paver: add README

Marc Cornellà 4 years ago
parent
commit
4fd2592007
2 changed files with 15 additions and 3 deletions
  1. 12 0
      plugins/paver/README.md
  2. 3 3
      plugins/paver/paver.plugin.zsh

+ 12 - 0
plugins/paver/README.md

@@ -0,0 +1,12 @@
+# Paver
+
+This plugin adds completion for the `paver` command-line tool of [Paver](https://pythonhosted.org/Paver/).
+
+To use it, add `paver` to the plugins array of your zshrc file:
+```zsh
+plugins=(... paver)
+```
+
+The completion function creates a cache of paver tasks with the name `.paver_tasks`,
+in the current working directory. It regenerates that cache when the `pavement.py`
+changes.

+ 3 - 3
plugins/paver/paver.plugin.zsh

@@ -1,7 +1,7 @@
 _paver_does_target_list_need_generating () {
-  [ ! -f .paver_targets ] && return 0;
-  [ pavement.py -nt .paver_targets ] && return 0;
-  return 1;
+  [ ! -f .paver_targets ] && return 0
+  [ pavement.py -nt .paver_targets ] && return 0
+  return 1
 }
 
 _paver () {