From: Stefan Kangas <stefankangas@gmail.com>
To: 59379@debbugs.gnu.org
Cc: Stefan Monnier <monnier@iro.umontreal.ca>
Subject: bug#59379: 29.0.50; `define-advice' documentation needs improving
Date: Fri, 18 Nov 2022 23:26:00 -0800 [thread overview]
Message-ID: <CADwFkmmPp+K=LsEe867soqXEYHzS_LKHpzzcsm3JCR8KRMX+aA@mail.gmail.com> (raw)
This bug report is about the documentation of the `define-advice' macro.
1. It is mentioned in
(info "(elisp) Advising Named Functions")
but there is no explanation of when one would want to use it instead
of `advice-add'. In fact, apart from its definition in that info
node, and its entry in the index, I see no other mention of it in the
manual.
It is mentioned before the `advice-add' function, which seems to
imply that it is more important?
2. It would also be good to have an example of how to use it, at least
it in the manual.
3. This is its argument list:
(define-advice SYMBOL (HOW LAMBDA-LIST &optional NAME DEPTH) &rest
BODY)
The HOW, LAMBDA-LIST, NAME, DEPTH parameters are not documented in
the docstring, nor in the info manual.
4. There also seem to be a mistake (or merely a typo) in the argument
list as described in the argument list (note that "HOW" above is
replaced with "where"):
-- Macro: define-advice symbol (where lambda-list &optional name depth)
&rest body
5. The documentation of NAME says that: "The advice is an anonymous
function if NAME is ‘nil’ or a function named ‘symbol@name’."
I struggle with parsing this sentence. It sounds like it is saying
that, if I want an anonymous function, I should define a function
named `symbol@name' (substituting `symbol' and `name') and then pass
that argument as the NAME argument? But then the function is not
anonymous?
6. Finally, the info manual says: "This macro defines a piece of advice
and adds it to the function named SYMBOL." Could the words "a piece
of advice" simply be replaced with "an advice", or is there some
important meaning that would be lost?
Thanks.
next reply other threads:[~2022-11-19 7:26 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-19 7:26 Stefan Kangas [this message]
2022-11-19 12:23 ` bug#59379: 29.0.50; `define-advice' documentation needs improving Visuwesh
2022-11-19 13:52 ` Stefan Kangas
2022-11-19 14:44 ` Visuwesh
2022-11-19 15:34 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-02-08 6:46 ` Visuwesh
2024-02-08 13:49 ` Visuwesh
2024-02-08 13:54 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADwFkmmPp+K=LsEe867soqXEYHzS_LKHpzzcsm3JCR8KRMX+aA@mail.gmail.com' \
--to=stefankangas@gmail.com \
--cc=59379@debbugs.gnu.org \
--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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.