Skip to content

Commit

Permalink
manual: Use "documentation string" instead of "doc string"
Browse files Browse the repository at this point in the history
That is what is commonly (but not consistently) used in Emacs'
own manuals.
  • Loading branch information
tarsius committed Nov 23, 2023
1 parent 44792c2 commit ff496fe
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
15 changes: 8 additions & 7 deletions docs/transient.org
Original file line number Diff line number Diff line change
Expand Up @@ -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) ::

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down
15 changes: 8 additions & 7 deletions docs/transient.texi
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ff496fe

Please sign in to comment.