Skip to content

Commit 8edbf81

Browse files
committed
[Docs] Document the eval spinner
1 parent 1aba017 commit 8edbf81

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,22 @@ NOTE: CIDER internally increases the timeout to 30 seconds for the first sync ev
161161

162162
== Configuration
163163

164+
=== Display Spinner During Evaluation
165+
166+
Some evaluation operations take a while to complete, so CIDER will display a
167+
visual indicator (a spinner) in the modeline to indicate this. The
168+
evaluation-in-progress spinner can be controlled by several variables:
169+
170+
* `cider-eval-spinner-type` (default value `'progress-bar) -
171+
controls the appearance of the spinner. See `spinner-types`
172+
for all possible options.
173+
* `cider-eval-spinner-delay` controls the time (in seconds) after which to
174+
show the spinner. The default value is 1 second.
175+
* `cider-show-eval-spinner` controls whether to show the spinner at all.
176+
Set this variable to `nil` to disable it.
177+
178+
NOTE: CIDER uses internally the excellent package https://github.com/Malabarba/spinner.el[spinner.el].
179+
164180
=== Overlays
165181

166182
When you evaluate code in Clojure files, the result is displayed in the buffer

0 commit comments

Comments
 (0)