GNU bug report logs - #18027
24.4.50; doc of `rectangle-mark-mode'

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 18027 in the body.
You can then email your comments to 18027 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: 24.4.50; doc of `rectangle-mark-mode'
Date: Tue, 15 Jul 2014 13:52:52 -0700 (PDT)

(emacs) `Rectangles' says this:

  The command `C-x <SPC>' (`rectangle-mark-mode') makes a "rectangular
  region".  It is a new feature introduced in GNU Emacs 24.4, and most
  commands now are still unaware of it, but kill and yank (*note
  Killing::) do work on the rectangle.

1. The manual should not be saying anything about something being new in
such-and-such a release.  It should always document the current release.
It can, if helpful, say something explicit about an older release, but
it has no business saying anything about "new" features.  New features
should be described in NEWS.

2. If some feature is limited, just say what the limitations are.  Do
not say anything about "currently" or "now".

3. This doc is not very helpful.  It does not say what a "rectangular
region" is or what it is for or what you can do with it or how.  It says
that this command makes one of these thingies, but it says nothing about
what it makes it from - in particular, it says nothing about the
relation of the region to "a rectangular region".  And it says nothing
about the appearance of the thing that it makes.  In short, it tells you
pretty much NOTHING about what this command is about.


In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-06-28 on ODIEONE
Bzr revision: 117431 rgm <at> gnu.org-20140628015517-eku6hj8mpgcvfnso
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''

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

From: Drew Adams <drew.adams <at> oracle.com>
To: 18027 <at> debbugs.gnu.org
Subject: RE: bug#18027: 24.4.50; doc of `rectangle-mark-mode'
Date: Tue, 15 Jul 2014 13:57:05 -0700 (PDT)

Plus, what's written in NEWS has the same problems.
It really says nothing about this new feature.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 18027 <at> debbugs.gnu.org
Subject: Re: bug#18027: 24.4.50; doc of `rectangle-mark-mode'
Date: Sat, 29 May 2021 06:55:42 +0200

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

> (emacs) `Rectangles' says this:
>
>   The command `C-x <SPC>' (`rectangle-mark-mode') makes a "rectangular
>   region".  It is a new feature introduced in GNU Emacs 24.4, and most
>   commands now are still unaware of it, but kill and yank (*note
>   Killing::) do work on the rectangle.
>
> 1. The manual should not be saying anything about something being new in
> such-and-such a release.  It should always document the current release.
> It can, if helpful, say something explicit about an older release, but
> it has no business saying anything about "new" features.  New features
> should be described in NEWS.

(I'm going through old bug reports that unfortunately got no response at
the time.)

This node has been completely rewritten in the years since this bug
report was filed, and it looks quite good to me now.  So I'm closing
this bug report.

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