diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2025-04-15 11:54:31 +0200 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2025-04-15 11:54:31 +0200 |
| commit | 55b01dc46026e5632a701b2ef1d04c21be8eb40c (patch) | |
| tree | 78e696d29861d97572341b24681b9d1c95a99c45 /docs | |
| parent | afc88b24e4faa5c7e246303648e70b4507652f32 (diff) | |
transient--insert-suffix: Do not signal error by default
In [1: 8daf9890] we started to signal an error instead of merely
showing a message on failure. That was a mistake, see #374.
Add new option `transient-error-on-insert-failure', so users can
opt-in to fatal errors for minor issues.
1: 2025-03-24 8daf9890ee65335a23eebc8919e9cfdd7c7249eb
transient--insert-suffix: Signal error if location is invalid
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/transient.org | 10 | ||||
| -rw-r--r-- | docs/transient.texi | 10 |
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/transient.org b/docs/transient.org index a53fae4..a18571a 100644 --- a/docs/transient.org +++ b/docs/transient.org @@ -899,6 +899,16 @@ that tree are not objects but have the form {{{codevar((LEVEL CLASS PLIST))}}}, This function edits the suffix or group at {{{var(LOC)}}} in {{{var(PREFIX)}}}, by setting the {{{var(PROP)}}} of its plist to {{{var(VALUE)}}}. +Most of these functions do not signal an error if they cannot perform +the requested modification. The functions that insert new suffixes +show a warning if {{{var(LOC)}}} cannot be found in {{{var(PREFIX,)}}} without signaling an +error. The reason for doing it like this is that establishing a key +binding (and that is what we essentially are trying to do here) should +not prevent the rest of the configuration from loading. Among these +functions only ~transient-get-suffix~ and ~transient-suffix-put~ signal +an error by default. If you really want the insert functions to also +signal an error, set ~transient-error-on-insert-failure~ to ~t~. + * Defining New Commands ** Technical Introduction diff --git a/docs/transient.texi b/docs/transient.texi index 42f4c67..c88f454 100644 --- a/docs/transient.texi +++ b/docs/transient.texi @@ -1055,6 +1055,16 @@ This function edits the suffix or group at @var{LOC} in @var{PREFIX}, by setting the @var{PROP} of its plist to @var{VALUE}. @end defun +Most of these functions do not signal an error if they cannot perform +the requested modification. The functions that insert new suffixes +show a warning if @var{LOC} cannot be found in @var{PREFIX} without signaling an +error. The reason for doing it like this is that establishing a key +binding (and that is what we essentially are trying to do here) should +not prevent the rest of the configuration from loading. Among these +functions only @code{transient-get-suffix} and @code{transient-suffix-put} signal +an error by default. If you really want the insert functions to also +signal an error, set @code{transient-error-on-insert-failure} to @code{t}. + @node Defining New Commands @chapter Defining New Commands |