emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/transient 9fb3f797f1 103/366: Regenerate manual


From: Jonas Bernoulli
Subject: [elpa] externals/transient 9fb3f797f1 103/366: Regenerate manual
Date: Tue, 25 Jan 2022 18:54:31 -0500 (EST)

branch: externals/transient
commit 9fb3f797f10fd069c2bffa7a3ead746aa53d1a25
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    Regenerate manual
---
 docs/transient.org  |  4 ++--
 docs/transient.texi | 35 +++++++++--------------------------
 2 files changed, 11 insertions(+), 28 deletions(-)

diff --git a/docs/transient.org b/docs/transient.org
index 721ed28a63..090a17550c 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -8,7 +8,7 @@
 #+TEXINFO_DIR_CATEGORY: Emacs
 #+TEXINFO_DIR_TITLE: Transient: (transient).
 #+TEXINFO_DIR_DESC: Transient Commands
-#+SUBTITLE: for version 0.1.0 (v0.1.0-96-g01a166f+1)
+#+SUBTITLE: for version 0.1.0 (v0.1.0-101-ga6ce195+1)
 
 #+TEXINFO_DEFFN: t
 #+OPTIONS: H:4 num:4 toc:2
@@ -37,7 +37,7 @@ Calling a suffix command usually causes the transient to be 
exited
 but suffix commands can also be configured to not exit the transient.
 
 #+TEXINFO: @noindent
-This manual is for Transient version 0.1.0 (v0.1.0-96-g01a166f+1).
+This manual is for Transient version 0.1.0 (v0.1.0-101-ga6ce195+1).
 
 #+BEGIN_QUOTE
 Copyright (C) 2018-2019 Jonas Bernoulli <jonas@bernoul.li>
diff --git a/docs/transient.texi b/docs/transient.texi
index 9da65b28e0..94ba706b26 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -31,7 +31,7 @@ General Public License for more details.
 @finalout
 @titlepage
 @title Transient User and Developer Manual
-@subtitle for version 0.1.0 (v0.1.0-96-g01a166f+1)
+@subtitle for version 0.1.0 (v0.1.0-101-ga6ce195+1)
 @author Jonas Bernoulli
 @page
 @vskip 0pt plus 1filll
@@ -65,7 +65,7 @@ Calling a suffix command usually causes the transient to be 
exited
 but suffix commands can also be configured to not exit the transient.
 
 @noindent
-This manual is for Transient version 0.1.0 (v0.1.0-96-g01a166f+1).
+This manual is for Transient version 0.1.0 (v0.1.0-101-ga6ce195+1).
 
 @quotation
 Copyright (C) 2018-2019 Jonas Bernoulli <jonas@@bernoul.li>
@@ -1244,32 +1244,15 @@ The preferred way of doing that is to call the 
@code{transient-args}
 function, which for infix arguments serves about the same purpose as
 @code{prefix-arg} serves for prefix arguments.
 
-@defun transient-args &optional prefix separate
+@defun transient-args &optional prefix
 
-This function returns the value of the transient from which the
-current suffix was called.  If the current suffix command was not
-called from a transient, then it returns @code{nil}.
+This function returns the value of the transient prefix command
+PREFIX@.
 
-If optional PREFIX is non-@code{nil}, then it should be a symbol, a
-transient prefix command.  In that case the value of the transient
-is only returned if the suffix was invoked from @strong{that} transient.
-Otherwise @code{nil} is returned.  This function is also used internally,
-in which PREFIX can also be a @code{transient-prefix} object.
-
-If optional SEPARATE is non-@code{nil}, then the arguments are separated
-into two groups.  If SEPARATE is @code{t}, they are separated into atoms
-and conses (@code{nil} isn't a valid value, so it doesn't matter that that
-is both an atom and a cons).
-
-SEPARATE can also be a predicate function, in which case the first
-element is a list of the values for which it returns non-@code{nil} and the
-second element is a list of the values for which it returns @code{nil}.
-
-For transients that are used to pass arguments to a subprocess (such
-as @code{git}), @code{stringp} is a useful value for SEPARATE, it separates
-non-positional arguments from positional arguments.  The value of
-Magit's file argument (@code{"--"}) for example looks like this: @code{("--"
-  file...)}."
+If the current command was invoked from the transient prefix command
+PREFIX, then it returns the active infix arguments.  If the current
+command was not invoked from PREFIX, then it returns the set, saved
+or default value for PREFIX@.
 @end defun
 
 @defvar current-transient-suffixes



reply via email to

[Prev in Thread] Current Thread [Next in Thread]