GNU bug report logs - #33168
26; Doc string of `region-bounds'

Previous Next

Package: emacs;

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

Date: Fri, 26 Oct 2018 15:49:01 UTC

Severity: minor

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 33168 in the body.
You can then email your comments to 33168 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#33168; Package emacs. (Fri, 26 Oct 2018 15:49:01 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. (Fri, 26 Oct 2018 15:49:01 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
Subject: 26; Doc string of `region-bounds'
Date: Fri, 26 Oct 2018 08:48:17 -0700 (PDT)
Doc string:

  Return the boundaries of the region as a pair of positions.
  Value is a list of cons cells of the form (START . END).

Those two sentences are incompatible.

The first says that it returns a _single pair_ of positions: (START END)
or (START . END).  (It doesn't say what it means by "pair".  If it means
a cons then it should say so.)

The second says that it returns a _list of such pairs_, that is, a list
of conses of the form (START . END), where START and END are buffer
positions.

Further, assuming that the second sentence is correct, something needs
to be said about what it means to be a boundary of the region.
Presumably, in the case of a contiguous region the return value is
((BEG . END)), where BEG is the start of the region and END is the END.
But what if the region is noncontiguous?  Something should be said
about what each (BEG<N> . END<N>) pair corresponds to (means).


In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 10.0.16299
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, 27 Oct 2018 10:53:01 GMT) Full text and rfc822 format available.

Notification sent to Drew Adams <drew.adams <at> oracle.com>:
bug acknowledged by developer. (Sat, 27 Oct 2018 10:53:02 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 33168-done <at> debbugs.gnu.org
Subject: Re: bug#33168: 26; Doc string of `region-bounds'
Date: Sat, 27 Oct 2018 13:52:41 +0300
> Date: Fri, 26 Oct 2018 08:48:17 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> Doc string:
> 
>   Return the boundaries of the region as a pair of positions.
>   Value is a list of cons cells of the form (START . END).
> 
> Those two sentences are incompatible.

Right; fixed.

> Further, assuming that the second sentence is correct, something needs
> to be said about what it means to be a boundary of the region.

I said "something" about that.

> Presumably, in the case of a contiguous region the return value is
> ((BEG . END)), where BEG is the start of the region and END is the END.
> But what if the region is noncontiguous?  Something should be said
> about what each (BEG<N> . END<N>) pair corresponds to (means).

And about this.

Thanks.




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 24 Nov 2018 12:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 6 years and 208 days ago.

Previous Next


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