diff options
| author | Daniel Shahaf <d.s@daniel.shahaf.name> | 2015-03-04 02:57:20 +0000 |
|---|---|---|
| committer | Peter Stephenson <pws@zsh.org> | 2015-03-04 09:18:07 +0000 |
| commit | 42e5f591f5227d829ca27fd534c34400d92a8553 (patch) | |
| tree | 13f86f4a65233d7ae1a925978ac08cfcd2c6e014 /Doc/Zsh/compsys.yo | |
| parent | 90d433b358763069c4ca912002c7963481e4f9bf (diff) | |
| download | zsh-42e5f591f5227d829ca27fd534c34400d92a8553.tar.gz zsh-42e5f591f5227d829ca27fd534c34400d92a8553.tar.xz zsh-42e5f591f5227d829ca27fd534c34400d92a8553.zip | |
34640: clarify documentation for _guard function
Diffstat (limited to 'Doc/Zsh/compsys.yo')
| -rw-r--r-- | Doc/Zsh/compsys.yo | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo index 5890f1704..89cd05121 100644 --- a/Doc/Zsh/compsys.yo +++ b/Doc/Zsh/compsys.yo @@ -4278,12 +4278,12 @@ option `tt(-)tt(-help)'. ) findex(_guard) item(tt(_guard) [ var(options) ] var(pattern descr))( -This function is intended to be used in the var(action) for -the specifications passed to tt(_arguments) and similar functions. It -returns immediately with a non-zero return status if -the string to be completed does not match the var(pattern). If the -pattern matches, the var(descr) is displayed; the function then returns -status zero if the word to complete is not empty, non-zero otherwise. +This function displays var(descr) if var(pattern) matches the string to +be completed. It is intended to be used in the var(action) for the +specifications passed to tt(_arguments) and similar functions. + +The return status is zero if the message was displayed and the word to +complete is not empty, and non-zero otherwise. The var(pattern) may be preceded by any of the options understood by tt(compadd) that are passed down from tt(_description), namely tt(-M), |