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

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 59779 in the body.
You can then email your comments to 59779 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: 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 #10 received at 59779-done <at> debbugs.gnu.org (full text, mbox):

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.

Previous Next

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