* bug#38158: 26.3; Function usage in docstring not documented
@ 2019-11-10 9:48 Allen Li
2019-11-10 12:11 ` Allen Li
0 siblings, 1 reply; 3+ messages in thread
From: Allen Li @ 2019-11-10 9:48 UTC (permalink / raw)
To: 38158
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#38158: 26.3; Function usage in docstring not documented
2019-11-10 9:48 bug#38158: 26.3; Function usage in docstring not documented Allen Li
@ 2019-11-10 12:11 ` Allen Li
2019-11-14 9:51 ` Eli Zaretskii
0 siblings, 1 reply; 3+ messages in thread
From: Allen Li @ 2019-11-10 12:11 UTC (permalink / raw)
To: 38158-done
On Sun, Nov 10, 2019 at 9:48 AM Allen Li <darkfeline@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
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#38158: 26.3; Function usage in docstring not documented
2019-11-10 12:11 ` Allen Li
@ 2019-11-14 9:51 ` Eli Zaretskii
0 siblings, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2019-11-14 9:51 UTC (permalink / raw)
To: Allen Li; +Cc: 38158
> From: Allen Li <darkfeline@felesatra.moe>
> Date: Sun, 10 Nov 2019 12:11:49 +0000
>
> On Sun, Nov 10, 2019 at 9:48 AM Allen Li <darkfeline@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.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-11-14 9:51 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-10 9:48 bug#38158: 26.3; Function usage in docstring not documented Allen Li
2019-11-10 12:11 ` Allen Li
2019-11-14 9:51 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).