add description of how to add a auto-removable suffix when using a ->state action with _values (14279)

1 files changed, 10 insertions, 0 deletions

diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 79574d321..0a203a7aa 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -4002,6 +4002,16 @@ when using an action of the form `tt(->)var(string)'.  With this
 function the tt(context) parameter will be set to the name of the
 value whose argument is to be completed.
 
+Note also that tt(_values) normally adds the character used as the
+separator between values as a auto-removable suffix so that users don't
+have to type it themselves.  But when using a `tt(->)var(string)' action
+tt(_values) can't do that because the matches for the argument will be
+generated by the calling function.  To get the usual behaviour, the
+implementor of the calling function has to add the suffix directly by
+passing the options `tt(-qS) var(x)' (where var(x) is the separator
+character specified with the tt(-s) option of tt(_values)) to the
+function generating the matches or to the tt(compadd) builtin.
+
 Like tt(_arguments), tt(_values) supports the tt(-C) option in
 which case you have to make the parameter tt(curcontext) local instead 
 of tt(context) (as described above).