summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2012-09-03 11:12:15 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2012-09-03 11:12:15 +0000
commitd3891edfca77ce587585990135242247a48595fc (patch)
tree061a77d2a9a70b5d8a34c7894ead1e5a1d393931 /Doc
parent260b433632310e847b5c540f2812cc0856576273 (diff)
downloadzsh-d3891edfca77ce587585990135242247a48595fc.tar.gz
zsh-d3891edfca77ce587585990135242247a48595fc.tar.xz
zsh-d3891edfca77ce587585990135242247a48595fc.zip
users/12713: returning REPLY to _user_expand sets description for expansion
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/compsys.yo4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 2787f66a7..2991c1f4a 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -3180,7 +3180,9 @@ var(_func) is the name of a shell function whose name must begin with
 tt(_) but is not otherwise special to the completion system.  The function
 is called with the trial word as an argument.  If the word is to be
 expanded, the function should set the array tt(reply) to a list of
-expansions.  The return status of the function is irrelevant.
+expansions.  Optionally, it can set tt(REPLY) to a word that will
+be used as a description for the set of expansions.
+The return status of the function is irrelevant.
 )
 endsitem()
 )