GNU bug report logs - #61609
26.3; Doc strings of `just-one-space` and `delete-horizontal-space'

Previous Next

Package: emacs;

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

Date: Sat, 18 Feb 2023 17:20:02 UTC

Severity: minor

Found in version 26.3

Done: Eli Zaretskii <eliz <at> gnu.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 61609 in the body.
You can then email your comments to 61609 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#61609; Package emacs. (Sat, 18 Feb 2023 17:20:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to Drew Adams <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sat, 18 Feb 2023 17:20:02 GMT) Full text and rfc822 format available.

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" <bug-gnu-emacs <at> gnu.org>
Subject: 26.3; Doc strings of `just-one-space` and `delete-horizontal-space'
Date: Sat, 18 Feb 2023 17:19:06 +0000

Please mention in the doc strings that a prefix arg is how you get the
behavior described for the argument.  The doc strings don't seem to be
properly written for users.

  just-one-space:

  Delete all spaces and tabs around point, leaving one space (or N spaces).
  If N is negative, delete newlines as well, leaving -N spaces.

  delete-horizontal-space:

  Delete all spaces and tabs around point.
  If BACKWARD-ONLY is non-nil, only delete them before point.

Nothing tells you that N for `just-one-space' is the numeric prefix arg
or that BACKWARD-ONLY for `delete-horizontal-space' is the (raw) prefix
arg.  Without checking the code users won't have a clue how to get the N
and BACKWORD-ONLY behaviors.

(The descriptions in the manual do provide this info that's missing from
the doc strings.)


In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19044
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''
Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Sat, 18 Feb 2023 18:05:02 GMT) Full text and rfc822 format available.
Notification sent to Drew Adams <drew.adams <at> oracle.com>:
bug acknowledged by developer. (Sat, 18 Feb 2023 18:05:02 GMT) Full text and rfc822 format available.

Message #10 received at 61609-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 61609-done <at> debbugs.gnu.org
Subject: Re: bug#61609: 26.3;
 Doc strings of `just-one-space` and `delete-horizontal-space'
Date: Sat, 18 Feb 2023 20:04:42 +0200

> From: Drew Adams <drew.adams <at> oracle.com>
> Date: Sat, 18 Feb 2023 17:19:06 +0000
> 
> Please mention in the doc strings that a prefix arg is how you get the
> behavior described for the argument.  The doc strings don't seem to be
> properly written for users.

Thanks, done for Emacs 29.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 19 Mar 2023 11:24:06 GMT) Full text and rfc822 format available.
This bug report was last modified 2 years and 93 days ago.

Previous Next

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