[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#18399: 24.4.50; nadvice :filter-args -vs- interactive
From: |
Stefan Monnier |
Subject: |
bug#18399: 24.4.50; nadvice :filter-args -vs- interactive |
Date: |
Thu, 04 Sep 2014 11:44:29 -0400 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.4.50 (gnu/linux) |
> I looked at the docs again and I agree. Sorry about the noise. Perhaps
> a note and/or a small example here would be nice for future users. If
> we were both fooled by this then perhaps others will be as well.
I installed the patch below, which I hope will help clear up such
confusion.
Stefan
=== modified file 'doc/lispref/ChangeLog'
--- doc/lispref/ChangeLog 2014-08-19 18:56:29 +0000
+++ doc/lispref/ChangeLog 2014-09-04 15:42:28 +0000
@@ -1,3 +1,8 @@
+2014-09-04 Stefan Monnier <monnier@iro.umontreal.ca>
+
+ * functions.texi (Core Advising Primitives): Add a note about the
+ confusing treatment of `interactive' for :filter-args (bug#18399).
+
2014-08-19 Eli Zaretskii <eliz@gnu.org>
* display.texi (Bidirectional Display): Update the Emacs's class
=== modified file 'doc/lispref/functions.texi'
--- doc/lispref/functions.texi 2014-05-27 01:09:45 +0000
+++ doc/lispref/functions.texi 2014-09-04 15:40:13 +0000
@@ -1220,15 +1220,6 @@
This macro is the handy way to add the advice @var{function} to the function
stored in @var{place} (@pxref{Generalized Variables}).
-If @var{function} is not interactive, then the combined function will inherit
-the interactive spec, if any, of the original function. Else, the combined
-function will be interactive and will use the interactive spec of
-@var{function}. One exception: if the interactive spec of @var{function}
-is a function (rather than an expression or a string), then the interactive
-spec of the combined function will be a call to that function with as sole
-argument the interactive spec of the original function. To interpret the spec
-received as argument, use @code{advice-eval-interactive-spec}.
-
@var{where} determines how @var{function} is composed with the
existing function, e.g. whether @var{function} should be called before, or
after the original function. @xref{Advice combinators}, for the list of
@@ -1271,6 +1262,21 @@
@code{:override} advice will override not only the original function but all
other advices applied to it as well.
@end table
+
+If @var{function} is not interactive, then the combined function will inherit
+the interactive spec, if any, of the original function. Else, the combined
+function will be interactive and will use the interactive spec of
+@var{function}. One exception: if the interactive spec of @var{function}
+is a function (rather than an expression or a string), then the interactive
+spec of the combined function will be a call to that function with as sole
+argument the interactive spec of the original function. To interpret the spec
+received as argument, use @code{advice-eval-interactive-spec}.
+
+Note: The interactive spec of @var{function} will apply to the combined
+function and should hence obey the calling convention of the combined function
+rather than that of @var{function}. In many cases, it makes no difference
+since they are identical, but it does matter for @code{:around},
+@code{:filter-args}, and @code{filter-return}, where @var{function}.
@end defmac
@defmac remove-function place function