branch: externals/transient
commit ff496fe5ad800443904cf7e5f569f915ac641ad2
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
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
