GNU bug report logs - #22813
24.5; doc string of `apropos-variable' - mention C-u

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Fri, 26 Feb 2016 05:18:02 UTC

Severity: minor

Found in version 24.5

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Kaushal Modi <kaushal.modi <at> gmail.com>, 22813 <at> 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)

> 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.
This bug report was last modified 9 years and 144 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.