GNU bug report logs - #18192
Incorrect implication in delete-{backward,forward}-char docstrings

Previous Next

Package: emacs;

Reported by: Reuben Thomas <rrt <at> sc3d.org>

Date: Mon, 4 Aug 2014 18:34:01 UTC

Severity: minor

Tags: fixed

Fixed in version 27.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#18192; Package emacs. (Mon, 04 Aug 2014 18:34:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to Reuben Thomas <rrt <at> sc3d.org>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 04 Aug 2014 18:34:02 GMT) Full text and rfc822 format available.

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

From: Reuben Thomas <rrt <at> sc3d.org>
To: bug-emacs <bug-emacs <at> gnu.org>
Subject: Incorrect implication in delete-{backward,forward}-char docstrings
Date: Mon, 4 Aug 2014 19:33:19 +0100
[Message part 1 (text/plain, inline)]
These two functions are marked interactive-only, yet the docstrings' last
sentence starts "Interactively," which may lead readers to infer that they
can be used non-interactively:

Interactively, N is the prefix arg, and
KILLFLAG is set if N was explicitly specified.

How about the following re-wording for the last sentence:

"A prefix arg becomes N, and sets KILLFLAG."

In fact, this solves another confusion: is pressing C-u "explicitly"
setting N? It might seem not, but it certainly causes KILLFLAG to be set.

If this is satisfactory, I can install a fix.

-- 
http://rrt.sc3d.org
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#18192; Package emacs. (Sat, 03 Aug 2019 19:15:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Reuben Thomas <rrt <at> sc3d.org>
Cc: 18192 <at> debbugs.gnu.org
Subject: Re: bug#18192: Incorrect implication in
 delete-{backward,forward}-char docstrings
Date: Sat, 03 Aug 2019 21:13:54 +0200
Reuben Thomas <rrt <at> sc3d.org> writes:

> These two functions are marked interactive-only, yet the docstrings' last
> sentence starts "Interactively," which may lead readers to infer that they can
> be used non-interactively:
>
> Interactively, N is the prefix arg, and
> KILLFLAG is set if N was explicitly specified.
>
> How about the following re-wording for the last sentence:
>
> "A prefix arg becomes N, and sets KILLFLAG."
>
> In fact, this solves another confusion: is pressing C-u "explicitly" setting N?
> It might seem not, but it certainly causes KILLFLAG to be set.

It a bit confusingly worded, and I've now installed the following phrase
instead:

"If called interactively, a numeric prefix argument specifies N, and
KILLFLAG is also set if a prefix argument is used."

While these functions are just supposed to be used interactively, they
can be used non-interactively, so I think it's right to call out the "if
called interactively" here, too.

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




Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 03 Aug 2019 19:15:02 GMT) Full text and rfc822 format available.

bug marked as fixed in version 27.1, send any further explanations to 18192 <at> debbugs.gnu.org and Reuben Thomas <rrt <at> sc3d.org> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 03 Aug 2019 19:15:03 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 01 Sep 2019 11:24:07 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 211 days ago.

Previous Next


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