GNU bug report logs - #20654
25.0.50; doc string of `query-replace': Describe interactive behavior first

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 20654 in the body.
You can then email your comments to 20654 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.0.50; doc string of `query-replace': Describe interactive behavior
 first
Date: Mon, 25 May 2015 14:35:04 -0700 (PDT)

Describe the command first of all from the point of view of an
interactive user, and only secondarily from the point of view of a Lisp
programmer.

The description starts out correctly, in that vein.  But it does not
describe the use of a prefix arg.  An Emacs user must wade through the
entire description, including specifics about each of the Lisp
parameters, before getting to the info about the prefix arg.  And even
then s?he must read attentively or s?he will miss it.

This StackExchange question, as well as comments and answers provided by
fairly experienced Emacs[Lisp] users, supports the need to fix this:
http://emacs.stackexchange.com/q/12688/105


In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm <at> gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 20654 <at> debbugs.gnu.org
Subject: Re: bug#20654: 25.0.50;
 doc string of `query-replace': Describe interactive behavior first
Date: Sat, 30 Apr 2016 21:29:12 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> Describe the command first of all from the point of view of an
> interactive user, and only secondarily from the point of view of a Lisp
> programmer.
>
> The description starts out correctly, in that vein.  But it does not
> describe the use of a prefix arg.  An Emacs user must wade through the
> entire description, including specifics about each of the Lisp
> parameters, before getting to the info about the prefix arg.  And even
> then s?he must read attentively or s?he will miss it.
>
> This StackExchange question, as well as comments and answers provided by
> fairly experienced Emacs[Lisp] users, supports the need to fix this:
> http://emacs.stackexchange.com/q/12688/105

I've now moved it earlier and rephrased it.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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