manual: Document inactive slot

2 files changed, 17 insertions, 0 deletions

diff --git a/docs/transient.org b/docs/transient.org
index 480fd2c..7da7e72 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -2604,6 +2604,14 @@ the ~level~ slot (see [[*Enabling and Disabling Suffixes]]) are defined.
 
 - ~parent~ The object for the parent group, if any.
 
+- ~inactive~ If an ~:if*~ predicate of a suffix or group returns ~nil~,
+  then it is not displayed in the menu, but it has to remain in the
+  internal object tree, in case that predicate later returns ~t~, and
+  the ~object~ therefore has to appear in the menu again.  Likewise a
+  group or suffix may be (potentially only temporarily) inactive due
+  to its ~level~.  The ~inactive~ slot is set accordingly.  Never set it
+  yourself.
+
 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.
diff --git a/docs/transient.texi b/docs/transient.texi
index 713530c..3f98272 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -2889,6 +2889,15 @@ the @code{level} slot (see @ref{Enabling and Disabling Suffixes}) are defined.
 @itemize
 @item
 @code{parent} The object for the parent group, if any.
+
+@item
+@code{inactive} If an @code{:if*} predicate of a suffix or group returns @code{nil},
+then it is not displayed in the menu, but it has to remain in the
+internal object tree, in case that predicate later returns @code{t}, and
+the @code{object} therefore has to appear in the menu again.  Likewise a
+group or suffix may be (potentially only temporarily) inactive due
+to its @code{level}.  The @code{inactive} slot is set accordingly.  Never set it
+yourself.
 @end itemize
 
 The following two slots are experimental.  If they are set for a