GNU bug report logs - #76797
29.1; read-string docstring doesn't mention return value

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#76797: closed (29.1; read-string docstring doesn't mention
 return value)
Date: Fri, 07 Mar 2025 17:16:01 +0000

[Message part 1 (text/plain, inline)]

Your message dated Fri, 7 Mar 2025 17:15:00 +0000
with message-id <CADwFkm=Bgp0+tussq+g+69gppFq8Ta4R+Zoti9oh9L2hFGXq0A <at> mail.gmail.com>
and subject line Re: bug#76797: 29.1; read-string docstring doesn't mention return value
has caused the debbugs.gnu.org bug report #76797,
regarding 29.1; read-string docstring doesn't mention return value
to be marked as done.

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


-- 
76797: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=76797
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Howard Melman <hmelman <at> gmail.com>
To: GNU Emacs <bug-gnu-emacs <at> gnu.org>
Subject: 29.1; read-string docstring doesn't mention return value
Date: Thu, 6 Mar 2025 21:37:55 -0500

The docstring for read-string in emacs 29.1 doesn't mention
its return value (though the 4th arg describes what it
returns if the user enters the empty string).

I agree it's kind of obvious that it returns the read string
but not seeing it explicitly made me scan for something I
might have been missing.

I suggest the first line instead of:

    Read a string from the minibuffer, prompting with string PROMPT.

be:

    Return a string read from the minibuffer, prompting with string PROMPT.

or if 71 characters is too long, one of:

    Return a string read from the minibuffer, prompting with PROMPT.
    Return a string read from the minibuffer, using PROMPT string.
    Return a string read from the minibuffer, using string PROMPT.

Or just mention the return value in the one of the other lines.

-- 

Howard

[Message part 3 (message/rfc822, inline)]

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Howard Melman <hmelman <at> gmail.com>, 76797-done <at> debbugs.gnu.org
Subject: Re: bug#76797: 29.1;
 read-string docstring doesn't mention return value
Date: Fri, 7 Mar 2025 17:15:00 +0000

Version: 30.2

Howard Melman <hmelman <at> gmail.com> writes:

> The docstring for read-string in emacs 29.1 doesn't mention
> its return value (though the 4th arg describes what it
> returns if the user enters the empty string).
>
> I agree it's kind of obvious that it returns the read string
> but not seeing it explicitly made me scan for something I
> might have been missing.
>
> I suggest the first line instead of:
>
>     Read a string from the minibuffer, prompting with string PROMPT.
>
> be:
>
>     Return a string read from the minibuffer, prompting with string PROMPT.
>
> or if 71 characters is too long, one of:
>
>     Return a string read from the minibuffer, prompting with PROMPT.
>     Return a string read from the minibuffer, using PROMPT string.
>     Return a string read from the minibuffer, using string PROMPT.
>
> Or just mention the return value in the one of the other lines.

Thanks, fixed on emacs-30.  Closing.

Previous Next

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