summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2024-12-19 18:13:53 +0100
committerJonas Bernoulli <jonas@bernoul.li>2024-12-19 18:13:53 +0100
commit52679f9853fd56358dd57e9bfcd8ff6533400cf2 (patch)
tree3e24339822182a1ff8e665d56ec215b15c8c4e3a /docs
parent042f37aa66e1b43afab8d0cf751da8b5c52f5282 (diff)
transient-toggle-docstrings: New command
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org9
-rw-r--r--docs/transient.texi9
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/transient.org b/docs/transient.org
index 907d268..c62b12d 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -436,6 +436,15 @@ like to use them for all menus, bind them in ~transient-map~.
This command copies the contents of the menu buffer to the kill
ring.
+- Command: transient-toggle-docstrings ::
+
+ This command toggle between showing suffix descriptions in the menu
+ (as usual) or showing the first lines of the respective docstrings
+ in their place. For commands that do not have a docstring, always
+ display the suffix description. Because there likely isn't enough
+ room to display multiple docstrings side-by-side, a single column
+ is used when displaying docstrings.
+
** Configuration
More options are described in [[* Common Suffix Commands]], in [[* Saving
diff --git a/docs/transient.texi b/docs/transient.texi
index 52259d1..1ff4d6f 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -594,6 +594,15 @@ This command copies the contents of the menu buffer to the kill
ring.
@end deffn
+@deffn Command transient-toggle-docstrings
+This command toggle between showing suffix descriptions in the menu
+(as usual) or showing the first lines of the respective docstrings
+in their place. For commands that do not have a docstring, always
+display the suffix description. Because there likely isn't enough
+room to display multiple docstrings side-by-side, a single column
+is used when displaying docstrings.
+@end deffn
+
@node Configuration
@section Configuration