branch: externals/transient
commit 7edc536f24af598589006b7380e477b054f2e4f9
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
manual: Move description of advise and advise* slots
---
docs/transient.org | 38 +++++++++++++++++++-------------------
docs/transient.texi | 46 +++++++++++++++++++++++-----------------------
2 files changed, 42 insertions(+), 42 deletions(-)
diff --git a/docs/transient.org b/docs/transient.org
index 06f4d1b8a4..480fd2ccdd 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -2597,12 +2597,26 @@ Also see [[*Suffix Classes]].
:UNNUMBERED: notoc
:END:
-This is the abstract superclass of ~transient-suffix~ and ~transient-group~.
-This is where the shared ~if*~ and ~inapt-if*~ slots (see [[*Predicate
Slots]]),
-the ~level~ slot (see [[*Enabling and Disabling Suffixes]]), and the ~advice~
-and ~advice*~ slots (see [[*Slots of ~transient-suffix~]]) are defined.
+This is the abstract superclass of ~transient-suffix~ and
+~transient-group~. In addition to the slots listed below, this class
+is also where the ~if*~ and ~inapt-if*~ slots (see [[*Predicate Slots]]) and
+the ~level~ slot (see [[*Enabling and Disabling Suffixes]]) are defined.
-- ~parent~ The object for the parent group.
+- ~parent~ The object for the parent group, if any.
+
+The following two slots are experimental. If they are set for a
+group, then they apply to all suffixes in that group, except for
+suffixes that themselves set the same slot to a non-~nil~ value.
+
+- ~advice~ A function used to advise the command. The advise is called
+ using ~(apply advice command args)~, i.e., it behaves like an "around"
+ advice.
+
+- ~advice*~ A function used to advise the command. Unlike ~advice~, this
+ advises not only the command body but also its ~interactive~ spec. If
+ both slots are non-~nil~, ~advice~ is used for the body and ~advice*~ is
+ used for the ~interactive~ form. When advising the ~interactive~ spec,
+ called using ~(funcall advice #'advice-eval-interactive-spec spec)~.
*** Slots of ~transient-suffix~
:PROPERTIES:
@@ -2657,20 +2671,6 @@ and ~advice*~ slots (see [[*Slots of
~transient-suffix~]]) are defined.
- ~definition~ A command, which is used if the body is omitted when
defining a command using ~transient-define-suffix~.
-The following two slots are experimental. They can also be set for a
-group, in which case they apply to all suffixes in that group, except
-for suffixes that set the same slot to a non-~nil~ value.
-
-- ~advice~ A function used to advise the command. The advise is called
- using ~(apply advice command args)~, i.e., it behaves like an "around"
- advice.
-
-- ~advice*~ A function used to advise the command. Unlike ~advice~, this
- advises not only the command body but also its ~interactive~ spec. If
- both slots are non-~nil~, ~advice~ is used for the body and ~advice*~ is
- used for the ~interactive~ form. When advising the ~interactive~ spec,
- called using ~(funcall advice #'advice-eval-interactive-spec spec)~.
-
*** Slots of ~transient-infix~
:PROPERTIES:
:UNNUMBERED: notoc
diff --git a/docs/transient.texi b/docs/transient.texi
index 6a09a351cf..713530c462 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -2881,14 +2881,32 @@ Also see @ref{Suffix Classes}.
@anchor{Slots of @code{transient-child}}
@subheading Slots of @code{transient-child}
-This is the abstract superclass of @code{transient-suffix} and
@code{transient-group}.
-This is where the shared @code{if*} and @code{inapt-if*} slots (see
@ref{Predicate Slots}),
-the @code{level} slot (see @ref{Enabling and Disabling Suffixes}), and the
@code{advice}
-and @code{advice*} slots (see @ref{Slots of @code{transient-suffix}}) are
defined.
+This is the abstract superclass of @code{transient-suffix} and
+@code{transient-group}. In addition to the slots listed below, this class
+is also where the @code{if*} and @code{inapt-if*} slots (see @ref{Predicate
Slots}) and
+the @code{level} slot (see @ref{Enabling and Disabling Suffixes}) are defined.
@itemize
@item
-@code{parent} The object for the parent group.
+@code{parent} The object for the parent group, if any.
+@end itemize
+
+The following two slots are experimental. If they are set for a
+group, then they apply to all suffixes in that group, except for
+suffixes that themselves set the same slot to a non-@code{nil} value.
+
+@itemize
+@item
+@code{advice} A function used to advise the command. The advise is called
+using @code{(apply advice command args)}, i.e., it behaves like an "around"
+advice.
+
+@item
+@code{advice*} A function used to advise the command. Unlike @code{advice},
this
+advises not only the command body but also its @code{interactive} spec. If
+both slots are non-@code{nil}, @code{advice} is used for the body and
@code{advice*} is
+used for the @code{interactive} form. When advising the @code{interactive}
spec,
+called using @code{(funcall advice #'advice-eval-interactive-spec spec)}.
@end itemize
@anchor{Slots of @code{transient-suffix}}
@@ -2958,24 +2976,6 @@ format this description.
defining a command using @code{transient-define-suffix}.
@end itemize
-The following two slots are experimental. They can also be set for a
-group, in which case they apply to all suffixes in that group, except
-for suffixes that set the same slot to a non-@code{nil} value.
-
-@itemize
-@item
-@code{advice} A function used to advise the command. The advise is called
-using @code{(apply advice command args)}, i.e., it behaves like an "around"
-advice.
-
-@item
-@code{advice*} A function used to advise the command. Unlike @code{advice},
this
-advises not only the command body but also its @code{interactive} spec. If
-both slots are non-@code{nil}, @code{advice} is used for the body and
@code{advice*} is
-used for the @code{interactive} form. When advising the @code{interactive}
spec,
-called using @code{(funcall advice #'advice-eval-interactive-spec spec)}.
-@end itemize
-
@anchor{Slots of @code{transient-infix}}
@subheading Slots of @code{transient-infix}
