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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Drew Adams <drew.adams <at> oracle.com>
Subject: bug#61609: closed (Re: bug#61609: 26.3; Doc strings of
 `just-one-space` and `delete-horizontal-space')
Date: Sat, 18 Feb 2023 18:05:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#61609: 26.3; Doc strings of `just-one-space` and `delete-horizontal-space'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 61609 <at> debbugs.gnu.org.

-- 
61609: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=61609
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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.

[Message part 3 (message/rfc822, inline)]

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

Previous Next

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