Skip to content

Commit bd54061

Browse files
committed
[Docs] Document cider-use-tooltips
1 parent cc23232 commit bd54061

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/modules/ROOT/pages/usage/working_with_documentation.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,21 @@ example, if you want to want to use Latex-style references
7474

7575
image::cider_see_also.gif[CIDER See Also]
7676

77+
== Displaying Documentation as Tooltips
78+
79+
By default CIDER will show the documentation for the symbol under the mouse in a
80+
tooltip (using an overlay) or your echo area. That's controlled by the
81+
configuration setting `cider-use-tooltips`. You can disable this behavior by
82+
setting the variable to `nil`.
83+
84+
----
85+
(setq cider-use-tooltips nil)
86+
----
87+
88+
The tooltips will also be disabled if `tooltip-mode` is disabled or `help-at-pt-display-when-idle` is set to `t`.
89+
90+
TIP: Check out the documentation of `help-at-pt-display-when-idle` to understand better how the `help-echo` Emacs functionality works.
91+
7792
== Keybindings
7893

7994
|===

0 commit comments

Comments
 (0)