4fd25920070f85bf358d297e79af1e85aac07f5a

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

paver: add README

Diff

 1diff --git a/plugins/paver/README.md b/plugins/paver/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..c38d898ba6ad498e8f892f72b2949f46912f3762
 4--- /dev/null
 5+++ b/plugins/paver/README.md
 6@@ -0,0 +1,12 @@
 7+# Paver
 8+
 9+This plugin adds completion for the `paver` command-line tool of [Paver](https://pythonhosted.org/Paver/).
10+
11+To use it, add `paver` to the plugins array of your zshrc file:
12+```zsh
13+plugins=(... paver)
14+```
15+
16+The completion function creates a cache of paver tasks with the name `.paver_tasks`,
17+in the current working directory. It regenerates that cache when the `pavement.py`
18+changes.
19diff --git a/plugins/paver/paver.plugin.zsh b/plugins/paver/paver.plugin.zsh
20index 40bdbd12f9b46078337f839abcc4aee869fd438b..7e70ea37ca0409b32f8fde1e7eba28b56842c695 100644
21--- a/plugins/paver/paver.plugin.zsh
22+++ b/plugins/paver/paver.plugin.zsh
23@@ -1,7 +1,7 @@
24 _paver_does_target_list_need_generating () {
25-  [ ! -f .paver_targets ] && return 0;
26-  [ pavement.py -nt .paver_targets ] && return 0;
27-  return 1;
28+  [ ! -f .paver_targets ] && return 0
29+  [ pavement.py -nt .paver_targets ] && return 0
30+  return 1
31 }
32 
33 _paver () {