zsh-workers
 help / color / mirror / code / Atom feed
From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: [PATCH] _describe: Make documentation more greppable.
Date: Fri,  3 Jun 2016 20:50:20 +0000	[thread overview]
Message-ID: <1464987020-5061-1-git-send-email-danielsh@tarsus.local2> (raw)

Make the running text refer to the parameters using their names given in
the signature.  This enables the reader to search for the name given in
the signature.
---

 Doc/Zsh/compsys.yo | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 203c436..c97f80f 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -4227,13 +4227,13 @@ 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
-first array contains the possible completions with their descriptions in
+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 second array is
-given, it should have the same number of elements as the first; in this
+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 the first array.  The completion list
-will retain the descriptions from the first array.  Finally, a set of
+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.
 
 If the option `tt(-o)' appears before the first argument, the matches added


                 reply	other threads:[~2016-06-03 20:50 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1464987020-5061-1-git-send-email-danielsh@tarsus.local2 \
    --to=d.s@daniel.shahaf.name \
    --cc=zsh-workers@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).