Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
[PATCH] docs: improve _describe documentation
- X-seq: zsh-workers 54450
- From: dana <dana@xxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: [PATCH] docs: improve _describe documentation
- Date: Sat, 02 May 2026 14:49:21 -0500
- Archived-at: <https://zsh.org/workers/54450>
- Feedback-id: i9be146f9:Fastmail
- List-id: <zsh-workers.zsh.org>
mainly just documenting the (...) syntax for giving the arrays in-line
dana
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 83032b54f..5d25eb539 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -4404,16 +4404,22 @@ Multiple groups separated by tt(-)tt(-) can be supplied, potentially with
different completion options var(opt)s.
The var(descr) is taken as a string to display above the matches if the
-tt(format) style for the tt(descriptions) tag is set. This is followed by
-one or two names of arrays followed by options to pass to tt(compadd). The
-array var(name1) contains the possible completions with their descriptions in
-the form `var(completion)tt(:)var(description)'. Any literal colons in
-var(completion) must be quoted with a backslash. If a var(name2) is
+tt(format) style for the tt(descriptions) tag is set.
+
+This is followed by one or two names of arrays. Alternatively, the arrays
+may be given inline, following the rules described below, using the syntax
+tt(LPAR())var(item) var(...)tt(RPAR()). (There is no separate
+tt(LPAR()LPAR())var(...)tt(RPAR()RPAR()) form as with tt(_arguments).)
+
+The array var(name1) contains the possible completions with their (optional)
+descriptions in the form `var(completion)tt(:)var(description)'. Any literal
+colons in var(completion) must be quoted with a backslash. If a var(name2) is
given, it should have the same number of elements as var(name1); in this
case the corresponding elements are added as possible completions instead
of the var(completion) strings from var(name1). The completion list
-will retain the descriptions from var(name1). Finally, a set of
-completion options can appear.
+will retain the descriptions from var(name1).
+
+Finally, a set of options to pass to tt(compadd) can appear.
If the option `tt(-o)' appears before the first argument, the matches added
will be treated as names of command options (N.B. not shell options),
Messages sorted by:
Reverse Date,
Date,
Thread,
Author