[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/transient ff496fe5ad 04/26: manual: Use "documentation
|
From: |
Jonas Bernoulli |
|
Subject: |
[elpa] externals/transient ff496fe5ad 04/26: manual: Use "documentation string" instead of "doc string" |
|
Date: |
Sun, 26 Nov 2023 19:41:58 -0500 (EST) |
branch: externals/transient
commit ff496fe5ad800443904cf7e5f569f915ac641ad2
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>
manual: Use "documentation string" instead of "doc string"
That is what is commonly (but not consistently) used in Emacs'
own manuals.
---
docs/transient.org | 15 ++++++++-------
docs/transient.texi | 15 ++++++++-------
2 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/docs/transient.org b/docs/transient.org
index d2d83a61c7..ea30dbd8c1 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -238,7 +238,7 @@ the latter, then you can later resume the stack of
transients using
Transient's predecessor bound {{{kbd(q)}}} instead of {{{kbd(C-g)}}} to the
quit command.
To learn how to get that binding back see ~transient-bind-q-to-quit~'s
-doc string.
+documentation string.
- Key: C-q (transient-quit-all) ::
@@ -408,8 +408,8 @@ What sort of documentation is shown depends on how the
transient was
defined. For infix commands that represent command-line arguments
this ideally shows the appropriate manpage. ~transient-help~ then tries
to jump to the correct location within that. Info manuals are also
-supported. The fallback is to show the command's doc string, for
-non-infix suffixes this is usually appropriate.
+supported. The fallback is to show the command's documentation
+string, for non-infix suffixes this is usually appropriate.
** Enabling and Disabling Suffixes
#+cindex: enabling suffixes
@@ -1770,12 +1770,13 @@ functions use ~describe-function~.
For prefixes, show the info manual, if that is specified using the
~info-manual~ slot. Otherwise, show the manpage if that is specified
- using the ~man-page~ slot. Otherwise, show the command's doc string.
+ using the ~man-page~ slot. Otherwise, show the command's
+ documentation string.
- For suffixes, show the command's doc string.
+ For suffixes, show the command's documentation string.
For infixes, show the manpage if that is specified. Otherwise show
- the command's doc string.
+ the command's documentation string.
** Prefix Slots
@@ -2104,7 +2105,7 @@ for {{{kbd(q)}}}.
If you want to get {{{kbd(q)}}}'s old binding back then you can do so. Doing
that is a bit more complicated than changing a single key binding, so
I have implemented a function, ~transient-bind-q-to-quit~ that makes the
-necessary changes. See its doc string for more information.
+necessary changes. See its documentation string for more information.
* Keystroke Index
:PROPERTIES:
diff --git a/docs/transient.texi b/docs/transient.texi
index 1e280ff8c5..3abd54c1d3 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -348,7 +348,7 @@ it returns to the previous transient, if any.
Transient's predecessor bound @kbd{q} instead of @kbd{C-g} to the quit command.
To learn how to get that binding back see @code{transient-bind-q-to-quit}'s
-doc string.
+documentation string.
@table @asis
@item @kbd{C-q} (@code{transient-quit-all})
@@ -544,8 +544,8 @@ What sort of documentation is shown depends on how the
transient was
defined. For infix commands that represent command-line arguments
this ideally shows the appropriate manpage. @code{transient-help} then tries
to jump to the correct location within that. Info manuals are also
-supported. The fallback is to show the command's doc string, for
-non-infix suffixes this is usually appropriate.
+supported. The fallback is to show the command's documentation
+string, for non-infix suffixes this is usually appropriate.
@node Enabling and Disabling Suffixes
@section Enabling and Disabling Suffixes
@@ -2003,12 +2003,13 @@ Show help for the prefix, infix or suffix command
represented by
For prefixes, show the info manual, if that is specified using the
@code{info-manual} slot. Otherwise, show the manpage if that is specified
-using the @code{man-page} slot. Otherwise, show the command's doc string.
+using the @code{man-page} slot. Otherwise, show the command's
+documentation string.
-For suffixes, show the command's doc string.
+For suffixes, show the command's documentation string.
For infixes, show the manpage if that is specified. Otherwise show
-the command's doc string.
+the command's documentation string.
@end defun
@node Prefix Slots
@@ -2380,7 +2381,7 @@ for @kbd{q}.
If you want to get @kbd{q}'s old binding back then you can do so. Doing
that is a bit more complicated than changing a single key binding, so
I have implemented a function, @code{transient-bind-q-to-quit} that makes the
-necessary changes. See its doc string for more information.
+necessary changes. See its documentation string for more information.
@node Keystroke Index
@appendix Keystroke Index
- [elpa] externals/transient updated (57bb749f98 -> af6eb31054), Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 7d9d639cdf 01/26: make: Only append newline to transient.texi if missing, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient ff496fe5ad 04/26: manual: Use "documentation string" instead of "doc string",
Jonas Bernoulli <=
- [elpa] externals/transient 44792c2bf9 03/26: manual: Copy-edit, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 163d0a83f7 02/26: manual: Regenerate texi file, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 004ca25946 06/26: Move definition of functions that handle pre-commands, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient f23f51e24e 07/26: Rename transient--{do => call}-pre-command, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 37307c1b8c 05/26: transient-prefix-object: New function, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 4c1cda9984 08/26: Rename transient-get-{predicate-for => pre-command}, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient f4b4dd42b9 14/26: Add transient--do-leave's missing color setting, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 0509c90e53 11/26: transient--key-face: New function, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 05754d1576 13/26: Rearrange pre-command color settings, Jonas Bernoulli, 2023/11/26
- [elpa] externals/transient 98d8cf8016 15/26: Fix transient--do-quit-one's color setting, Jonas Bernoulli, 2023/11/26