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

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 38158 in the body.
You can then email your comments to 38158 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: 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

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

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 #13 received at 38158 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Allen Li <darkfeline <at> felesatra.moe>
Cc: 38158 <at> debbugs.gnu.org
Subject: Re: bug#38158: 26.3; Function usage in docstring not documented
Date: Thu, 14 Nov 2019 11:51:44 +0200

> From: Allen Li <darkfeline <at> felesatra.moe>
> 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.

Can you describe how you looked for this?  Did you use the 'i' command
in Info?  It's possible that we need to improve the indexing.

Previous Next

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