GNU bug report logs - #59014
29.0.50; single string in function body should act as doc string

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 59014 in the body.
You can then email your comments to 59014 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: 29.0.50; single string in function body should act as doc string
Date: Fri, 04 Nov 2022 13:26:22 +0100

According to the Emacs lisp manual, node "Documentation Strings of Functions":

    You may wonder how the documentation string could be optional, since
    there are required components of the function that follow it (the
    body). Since evaluation of a string returns that string, without any
    side effects, it has no effect if it is not the last form in the
    body. Thus, in practice, there is no confusion between the first
    form of the body and the documentation string; if the only body form
    is a string then it serves both as the return value and as the
    documentation.

This last sentence is no longer true in 29.0.50, the single string is
not used as doc string:

(defun f () "foo")
⇒ f
(f)
⇒ "foo"
(documentation 'f)
⇒ nil
(emacs-version)
⇒ "GNU Emacs 29.0.50 (build 3, x86_64-pc-linux-gnu, GTK+ Version 3.24.5, cairo version 1.16.0)
 of 2022-11-03"

Hope this helps,
Nicolas

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Nicolas Graner <nicolas <at> graner.name>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 59014 <at> debbugs.gnu.org
Subject: Re: bug#59014: 29.0.50;
 single string in function body should act as doc string
Date: Fri, 04 Nov 2022 14:55:54 +0200

> From: Nicolas Graner <nicolas <at> graner.name>
> Date: Fri, 04 Nov 2022 13:26:22 +0100
> 
> According to the Emacs lisp manual, node "Documentation Strings of Functions":
> 
>     You may wonder how the documentation string could be optional, since
>     there are required components of the function that follow it (the
>     body). Since evaluation of a string returns that string, without any
>     side effects, it has no effect if it is not the last form in the
>     body. Thus, in practice, there is no confusion between the first
>     form of the body and the documentation string; if the only body form
>     is a string then it serves both as the return value and as the
>     documentation.
> 
> This last sentence is no longer true in 29.0.50, the single string is
> not used as doc string:
> 
> (defun f () "foo")
> ⇒ f
> (f)
> ⇒ "foo"
> (documentation 'f)
> ⇒ nil
> (emacs-version)
> ⇒ "GNU Emacs 29.0.50 (build 3, x86_64-pc-linux-gnu, GTK+ Version 3.24.5, cairo version 1.16.0)
>  of 2022-11-03"

Thanks.

Stefan, this seems to be due to your changes in commit
39e8fd357dd0a1f3776c05eee2cc5be451686712.  Specifically, the new
function-documentation returns nil in this case.  Could you please
take a look at this?

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 59014 <at> debbugs.gnu.org, Nicolas Graner <nicolas <at> graner.name>
Subject: Re: bug#59014: 29.0.50; single string in function body should act
 as doc string
Date: Fri, 04 Nov 2022 11:14:55 -0400

>> From: Nicolas Graner <nicolas <at> graner.name>
>> Date: Fri, 04 Nov 2022 13:26:22 +0100
>> 
>> According to the Emacs lisp manual, node "Documentation Strings of Functions":
>> 
>>     You may wonder how the documentation string could be optional, since
>>     there are required components of the function that follow it (the
>>     body). Since evaluation of a string returns that string, without any
>>     side effects, it has no effect if it is not the last form in the
>>     body. Thus, in practice, there is no confusion between the first
>>     form of the body and the documentation string; if the only body form
>>     is a string then it serves both as the return value and as the
>>     documentation.

Boy, I should (re)read this manual more regularly.  I was convinced the
intended behavior was to treat (defun f () "foo") as a function with no
docstring (as witnessed in the resulting behavior I implemented).

> Stefan, this seems to be due to your changes in commit
> 39e8fd357dd0a1f3776c05eee2cc5be451686712.  Specifically, the new
> function-documentation returns nil in this case.  Could you please
> take a look at this?

Will do,


        Stefan

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 59014 <at> debbugs.gnu.org, Nicolas Graner <nicolas <at> graner.name>
Subject: Re: bug#59014: 29.0.50; single string in function body should act
 as doc string
Date: Fri, 04 Nov 2022 12:00:24 -0400

>> Stefan, this seems to be due to your changes in commit
>> 39e8fd357dd0a1f3776c05eee2cc5be451686712.  Specifically, the new
>> function-documentation returns nil in this case.  Could you please
>> take a look at this?

Should be fixed now,


        Stefan

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

From: Nicolas Graner <nicolas <at> graner.name>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: eliz <at> gnu.org, 59014 <at> debbugs.gnu.org
Subject: Re: bug#59014: 29.0.50; single string in function body should act
 as doc string
Date: Fri, 04 Nov 2022 17:30:14 +0100

Stefan Monnier <monnier <at> iro.umontreal.ca> wrote on 2022-11-04 12:00:
>>> Stefan, this seems to be due to your changes in commit
>>> 39e8fd357dd0a1f3776c05eee2cc5be451686712.  Specifically, the new
>>> function-documentation returns nil in this case.  Could you please
>>> take a look at this?
>
> Should be fixed now,

Thanks.
Nicolas

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 59014 <at> debbugs.gnu.org, nicolas <at> graner.name
Subject: Re: bug#59014: 29.0.50; single string in function body should act
 as doc string
Date: Fri, 04 Nov 2022 18:52:31 +0200

> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: Nicolas Graner <nicolas <at> graner.name>,  59014 <at> debbugs.gnu.org
> Date: Fri, 04 Nov 2022 12:00:24 -0400
> 
> >> Stefan, this seems to be due to your changes in commit
> >> 39e8fd357dd0a1f3776c05eee2cc5be451686712.  Specifically, the new
> >> function-documentation returns nil in this case.  Could you please
> >> take a look at this?
> 
> Should be fixed now,

Thanks, works now.

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: 59014-done <at> debbugs.gnu.org
Subject: Re: bug#59014: 29.0.50; single string in function body should act
 as doc string
Date: Fri, 04 Nov 2022 13:44:18 -0400

>> Should be fixed now,
> Thanks, works now.

Closing,


        Stefan

Previous Next

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