GNU bug report logs - #67499
[PATCH] Add use cases of (fn) documentation facility.

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Jeremy Bryant <jb <at> jeremybryant.net>
Subject: bug#67499: closed (Re: Fwd: bug#67499: [PATCH] Add use cases of
 (fn) documentation facility.)
Date: Sat, 16 Dec 2023 12:59:02 +0000

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

Your bug report

#67499: [PATCH] Add use cases of (fn) documentation facility.

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 67499 <at> debbugs.gnu.org.

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

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jeremy Bryant <jb <at> jeremybryant.net>
Cc: 67499-done <at> debbugs.gnu.org
Subject: Re: Fwd: bug#67499: [PATCH] Add use cases of (fn) documentation
 facility.
Date: Sat, 16 Dec 2023 14:58:27 +0200

> From: Jeremy Bryant <jb <at> jeremybryant.net>
> Date: Tue, 12 Dec 2023 22:15:59 +0000
> 
> Kindly let me know if the attached patch is good to install or if
> anything else is needed to work on for this bug report?

Thanks, now installed on the emacs-29 branch, and closing the bug.

[Message part 3 (message/rfc822, inline)]

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Add use cases of (fn) documentation facility.
Date: Mon, 27 Nov 2023 23:30:33 +0000

[Message part 4 (text/plain, inline)]

Tags: patch


I have written a proposed addition to the Elisp manual.  In now-closed
bug 66928, there was a discussion related to the use of \(fn) in doc
strings, and I have drafted some examples to explain how this facility
could be used.  The addition is presented as @ifnottex... in order to
reduce the cost of the printed manual.

Feedback welcome on draft before I refine further, on conventions, section of
manual, style etc.





> Interesting, thank you 
> Perhaps it would be of interest to add some text to the elisp manual in
> (elisp) Function Documentation

> Are there any conventions for manual additions?
> in particular to keep the number of printed pages limited is there a way
> to say 'don't print this node'?

> thanks
> Jeremy


> Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

> >> One question, the elisp manual mentions that the \(fn ARGLIST) facility
> >> is particularly useful for macros.
> >>
> >> Why would we use this for defuns?
> >
> > We use it for some defuns where ELisp's arglist functionality is not
> > refined enough to express the intention of the programmer.
> > For example, the "real" arglist may be
> >
> >     name args &optional docstring &rest body
> >
> > but the intended arglist is
> >
> >     name args [docstring] &rest body
> >
> > i.e. if `docstring` is not a string it's taken as the first instruction
> > of `body`.
> >
> >
> >         Stefan

[0001-Add-use-cases-of-fn-documentation-facility.patch (text/patch, attachment)]

Previous Next

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