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

Message #17 received at 22813 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Kaushal Modi <kaushal.modi <at> gmail.com>, 22813 <at> debbugs.gnu.org
Subject: RE: bug#22813: 24.5; doc string of `apropos-variable' - mention C-u
Date: Fri, 26 Feb 2016 06:40:14 -0800 (PST)

> 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.

Eli's response was better than mine.
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.