unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 66928@debbugs.gnu.org
Subject: bug#66928: [PATCH 2/2] Update names to match the docstring
Date: Mon, 06 Nov 2023 22:55:39 +0000	[thread overview]
Message-ID: <87msvqv68y.fsf@jeremybryant.net> (raw)
In-Reply-To: <jwv34xk70zf.fsf-monnier+emacs@gnu.org>


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@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






  reply	other threads:[~2023-11-06 22:55 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-04 12:49 bug#66928: [PATCH 2/2] Update names to match the docstring Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-04 13:00 ` Eli Zaretskii
2023-11-04 16:13 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-04 22:56   ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-05 14:09     ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-06 22:55       ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-11-12 21:02         ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-13 13:58           ` Eli Zaretskii
2023-11-04 23:34   ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-12 20:54 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors

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=87msvqv68y.fsf@jeremybryant.net \
    --to=bug-gnu-emacs@gnu.org \
    --cc=66928@debbugs.gnu.org \
    --cc=jb@jeremybryant.net \
    --cc=monnier@iro.umontreal.ca \
    /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).