Skip to content

Commit c8ed97a

Browse files
committed
Further document how do use the error overlays
1 parent b5e4c62 commit c8ed97a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,17 @@ variable.
189189
(setq cider-overlays-use-font-lock t)
190190
----
191191

192-
If you don't like seeing overlays so often,
192+
Overlays will be shown for errors,
193+
as long as they are not already displayed by `cider-stacktrace-mode`.
194+
In order to always favor error overlays over the `\*cider-error\*` buffer,
195+
please customize:
196+
197+
[source,lisp]
198+
----
199+
(setq cider-show-error-buffer nil)
200+
----
201+
202+
If you only want to see overlays for errors (and not for successful evaluations),
193203
you can restrict overlays to only be shown for errors
194204
(and display non-error results in the echo area at the bottom)
195205
by customizing the `cider-use-overlays` variable:
@@ -285,7 +295,7 @@ By default CIDER will display the output produced by some evaluation in the REPL
285295
(setq cider-interactive-eval-output-destination 'output-buffer)
286296
----
287297

288-
Additionally, there's the variable `cider-redirect-server-output-to-repl` that captures output that would normally end up in the `*nrepl-server*` buffer (provided it has been started via `cider-jack-in`) and redirects it to the REPL buffer. You can disable this redirection like this:
298+
Additionally, there's the variable `cider-redirect-server-output-to-repl` that captures output that would normally end up in the `\*nrepl-server\*` buffer (provided it has been started via `cider-jack-in`) and redirects it to the REPL buffer. You can disable this redirection like this:
289299

290300
[source,lisp]
291301
----

0 commit comments

Comments
 (0)