bug#59014: 29.0.50; single string in function body should act as doc string

bug#59014: 29.0.50; single string in function body should act as doc string

[Nicolas Graner]

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

bug#59014: 29.0.50; single string in function body should act as doc string

[Eli Zaretskii]

> From: Nicolas Graner <nicolas@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?

bug#59014: 29.0.50; single string in function body should act as doc string

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>> From: Nicolas Graner <nicolas@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

bug#59014: 29.0.50; single string in function body should act as doc string

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>> 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

bug#59014: 29.0.50; single string in function body should act as doc string

[Nicolas Graner]

Stefan Monnier <monnier@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

bug#59014: 29.0.50; single string in function body should act as doc string

[Eli Zaretskii]

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: Nicolas Graner <nicolas@graner.name>,  59014@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.

bug#59014: 29.0.50; single string in function body should act as doc string

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

Closing,


        Stefan