From: Allen Li <darkfeline@felesatra.moe>
To: 38158-done@debbugs.gnu.org
Subject: bug#38158: 26.3; Function usage in docstring not documented
Date: Sun, 10 Nov 2019 12:11:49 +0000 [thread overview]
Message-ID: <CADbSrJzGGmcXxqxGKPS1zx6NTEdQoLw9GdifTVTp3xdRj2SV3w@mail.gmail.com> (raw)
In-Reply-To: <80h83c6p07.fsf@felesatra.moe>
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
next prev parent reply other threads:[~2019-11-10 12:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-10 9:48 bug#38158: 26.3; Function usage in docstring not documented Allen Li
2019-11-10 12:11 ` Allen Li [this message]
2019-11-14 9:51 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CADbSrJzGGmcXxqxGKPS1zx6NTEdQoLw9GdifTVTp3xdRj2SV3w@mail.gmail.com \
--to=darkfeline@felesatra.moe \
--cc=38158-done@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).