GNU bug report logs - #59779
string-equal-ignore-case's docstring is misleading

Previous Next

Package: emacs;

Reported by: Nicolas Graner <nicolas <at> graner.name>

Date: Fri, 2 Dec 2022 16:58:01 UTC

Severity: normal

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#59779: closed (string-equal-ignore-case's docstring is
 misleading)
Date: Fri, 02 Dec 2022 17:10:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Fri, 02 Dec 2022 19:08:54 +0200
with message-id <83359xg2c9.fsf <at> gnu.org>
and subject line Re: bug#59779: string-equal-ignore-case's docstring is misleading
has caused the debbugs.gnu.org bug report #59779,
regarding string-equal-ignore-case's docstring is misleading
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
59779: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=59779
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Nicolas Graner <nicolas <at> graner.name>
To: bug-gnu-emacs <at> gnu.org 
Subject: string-equal-ignore-case's docstring is misleading
Date: Fri, 02 Dec 2022 17:57:15 +0100
The docstring for string-equal-ignore-case reads:
  Like ‘string-equal’, but case-insensitive.

However, string-equal accepts symbols and strings as arguments, while
string-equal-ignore-case accepts only strings. This can be confusing to
people familiar with string-equal.

Either string-equal-ignore-case should be made to accept symbols as
arguments, or the doc should be clarified.

Nicolas


[Message part 3 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Nicolas Graner <nicolas <at> graner.name>
Cc: 59779-done <at> debbugs.gnu.org
Subject: Re: bug#59779: string-equal-ignore-case's docstring is misleading
Date: Fri, 02 Dec 2022 19:08:54 +0200
> From: Nicolas Graner <nicolas <at> graner.name>
> Date: Fri, 02 Dec 2022 17:57:15 +0100
> 
> The docstring for string-equal-ignore-case reads:
>   Like ‘string-equal’, but case-insensitive.
> 
> However, string-equal accepts symbols and strings as arguments, while
> string-equal-ignore-case accepts only strings. This can be confusing to
> people familiar with string-equal.
> 
> Either string-equal-ignore-case should be made to accept symbols as
> arguments, or the doc should be clarified.

I fixed the documentation, thanks.


This bug report was last modified 2 years and 230 days ago.

Previous Next


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