all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Kaushal Modi <kaushal.modi@gmail.com>, 22813@debbugs.gnu.org
Subject: bug#22813: 24.5; doc string of `apropos-variable' - mention C-u
Date: Fri, 26 Feb 2016 06:33:20 -0800 (PST)	[thread overview]
Message-ID: <3c8ac019-cb35-4654-b747-c2eb6493cdd6@default> (raw)
In-Reply-To: <CAFyQvY3k-XF0r3P-2va0iiw8eje-YxO4WWsOG96hTXWdxfznLA@mail.gmail.com>

> How about the below patch:
> 
> -When DO-NOT-ALL is non-nil, show user options only, i.e. behave
> +With prefix argument DO-NOT-ALL non-nil, show user options only,

Conventionally we address doc strings for commands to an interactive user.

We say something like "With a prefix argument...", not mentioning it by
name as a parameter.  We may also (at the end) say something like
"When called from Lisp, DO-NOT-ALL..."  IOW, the interactive user
gets a coherent description that does not involve Lisp parameters
s?he need not bother with.





  parent reply	other threads:[~2016-02-26 14:33 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-26  5:17 bug#22813: 24.5; doc string of `apropos-variable' - mention C-u Drew Adams
2016-02-26 13:15 ` Kaushal Modi
2016-02-26 14:14   ` Eli Zaretskii
2016-02-26 14:33   ` Drew Adams [this message]
2016-02-26 14:40     ` Drew Adams
2016-02-26 14:52       ` Kaushal Modi
2016-02-26 15:41         ` Eli Zaretskii
2016-02-26 15:48           ` Kaushal Modi
2016-02-26 18:33             ` Eli Zaretskii

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=3c8ac019-cb35-4654-b747-c2eb6493cdd6@default \
    --to=drew.adams@oracle.com \
    --cc=22813@debbugs.gnu.org \
    --cc=kaushal.modi@gmail.com \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.