[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/cider bd54061210 3/3: [Docs] Document cider-use-tooltips
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/cider bd54061210 3/3: [Docs] Document cider-use-tooltips |
Date: |
Sun, 12 Mar 2023 07:00:31 -0400 (EDT) |
branch: elpa/cider
commit bd54061210d2ad394cc784b03083c9bd64190272
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>
[Docs] Document cider-use-tooltips
---
.../ROOT/pages/usage/working_with_documentation.adoc | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
b/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
index 9676d0772e..5d2de0a602 100644
--- a/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
+++ b/doc/modules/ROOT/pages/usage/working_with_documentation.adoc
@@ -74,6 +74,21 @@ example, if you want to want to use Latex-style references
image::cider_see_also.gif[CIDER See Also]
+== Displaying Documentation as Tooltips
+
+By default CIDER will show the documentation for the symbol under the mouse in
a
+tooltip (using an overlay) or your echo area. That's controlled by the
+configuration setting `cider-use-tooltips`. You can disable this behavior by
+setting the variable to `nil`.
+
+----
+(setq cider-use-tooltips nil)
+----
+
+The tooltips will also be disabled if `tooltip-mode` is disabled or
`help-at-pt-display-when-idle` is set to `t`.
+
+TIP: Check out the documentation of `help-at-pt-display-when-idle` to
understand better how the `help-echo` Emacs functionality works.
+
== Keybindings
|===