GNU bug report logs - #13081
24.3.50; doc of `compare-strings' says nothing about the compare function used

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 13081 in the body.
You can then email your comments to 13081 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.3.50;
	doc of `compare-strings' says nothing about the compare function used
Date: Tue, 4 Dec 2012 10:35:28 -0800

The doc mentions case-sensitivity, and it says what the function does if
the specified portions match etc.  But it says NOTHING (apart from
possibly ignoring case) about what "matching" means.  Is lexicographic
order used?
 
How can you document a function about comparing two sequences without
defining/mentioning the helper function that is used to compare two
elements, one from each sequence?
 

In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600)
 of 2012-12-03 on MS-W7-DANI
Bzr revision: 111077
agustin.martin <at> hispalinux.es-20121203172342-ifsebjmhksk28qa9
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -Ic:/emacs/libs/libXpm-3.5.10/include -Ic:/emacs/libs/libXpm-3.5.10/src
 -Ic:/emacs/libs/libpng-1.2.37-lib/include -Ic:/emacs/libs/zlib-1.2.5
 -Ic:/emacs/libs/giflib-4.1.4-1-lib/include
 -Ic:/emacs/libs/jpeg-6b-4-lib/include
 -Ic:/emacs/libs/tiff-3.8.2-1-lib/include
 -Ic:/emacs/libs/libxml2-2.7.8-w32-bin/include/libxml2
 -Ic:/emacs/libs/gnutls-3.0.9-w32-bin/include
 -Ic:/emacs/libs/libiconv-1.9.2-1-lib/include'
 

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <13081 <at> debbugs.gnu.org>
Subject: RE: bug#13081: 24.3.50;
	doc of `compare-strings' says nothing about the compare function used
Date: Tue, 4 Dec 2012 10:44:34 -0800

1. I should have said that the doc problem applies to both the doc string and
Elisp manual.

2. What's more, the doc string says that "END1 and END2 default to".  This
language is incorrect - there is no defaulting.  These parameters are mandatory,
so they do not have any default values.

What the doc should say is two things:

a. START1, START2, END1, and END2 are either 0-based indexes into the string.
(This information is missing.)

b. START1, START2, END1, and END2 can each alternatively be nil.  For START1 and
START2, nil is the same as 0.  For END1 and END2, nil is the same as the length
of STR1 and STR2, respectively.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <13081 <at> debbugs.gnu.org>
Subject: RE: bug#13081: 24.3.50;
	doc of `compare-strings' says nothing about the compare function used
Date: Tue, 4 Dec 2012 10:50:16 -0800

> a. START1, START2, END1, and END2 are either 0-based indexes 
> into the string.  (This information is missing.)
> 
> b. START1, START2, END1, and END2 can each alternatively be 
> nil.

Typo in above text: strike the "either".  Or else add "or nil" after "either"
and rephrase (b) to just say what happens when nil.

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

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 13081-done <at> debbugs.gnu.org
Subject: Re: bug#13081: 24.3.50;
	doc of `compare-strings' says nothing about the compare function used
Date: Sat, 15 Dec 2012 21:44:38 +0800

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

> The doc mentions case-sensitivity, and it says what the function does if
> the specified portions match etc.  But it says NOTHING (apart from
> possibly ignoring case) about what "matching" means.  Is lexicographic
> order used?

Fixed, thanks.  (The other issues too.)

Previous Next

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