GNU bug report logs - #38158
26.3; Function usage in docstring not documented

Previous Next

Package: emacs;

Reported by: Allen Li <darkfeline <at> felesatra.moe>

Date: Sun, 10 Nov 2019 09:49:01 UTC

Severity: normal

Found in version 26.3

Done: Allen Li <darkfeline <at> felesatra.moe>

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: Allen Li <darkfeline <at> felesatra.moe>
Subject: bug#38158: closed (Re: 26.3; Function usage in docstring not
 documented)
Date: Sun, 10 Nov 2019 12:13:03 +0000

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

#38158: 26.3; Function usage in docstring not documented

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 38158 <at> debbugs.gnu.org.

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

[Message part 2 (message/rfc822, inline)]
From: Allen Li <darkfeline <at> felesatra.moe>
To: 38158-done <at> debbugs.gnu.org
Subject: Re: 26.3; Function usage in docstring not documented
Date: Sun, 10 Nov 2019 12:11:49 +0000

On Sun, Nov 10, 2019 at 9:48 AM Allen Li <darkfeline <at> felesatra.moe> wrote:
>
> It is not documented in the Elisp info manual that a function docstring
> ending with:
>
> \(fn SOME ARGS)
>
> will have a custom usage displayed by `describe-function'.
>
> It seems useful to document this.

Never mind, I found this documented under Function Documentation.  I
somehow missed it the first time C-sing in the manual.

>
> In GNU Emacs 26.3 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.10)
>  of 2019-08-29 built on juergen
> Windowing system distributor 'The X.Org Foundation', version 11.0.12005000
> System Description:     Arch Linux


[Message part 3 (message/rfc822, inline)]
From: Allen Li <darkfeline <at> felesatra.moe>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.3; Function usage in docstring not documented
Date: Sun, 10 Nov 2019 01:48:24 -0800

It is not documented in the Elisp info manual that a function docstring
ending with:

\(fn SOME ARGS)

will have a custom usage displayed by `describe-function'.

It seems useful to document this.

In GNU Emacs 26.3 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.10)
 of 2019-08-29 built on juergen
Windowing system distributor 'The X.Org Foundation', version 11.0.12005000
System Description:	Arch Linux
This bug report was last modified 5 years and 185 days ago.

Previous Next

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