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: Allen Li <darkfeline <at> felesatra.moe>
To: 38158 <at> debbugs.gnu.org
Subject: bug#38158: 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.