Skip to content

Commit 934e44c

Browse files
committed
[Docs] Add a note about pretty-printed results
1 parent d12269c commit 934e44c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,19 @@ to display it in a dedicated buffer. You can do this with
6060
`cider-pprint-eval-last-sexp` (kbd:[C-c C-p]). As a bonus -
6161
the result will be pretty-printed in the result buffer.
6262

63+
.Why aren't results always pretty-printed?
64+
****
65+
Many people might be wondering why doesn't CIDER pretty-print all of the results
66+
all of the time. After all - pretty-printed results are always easier to read, right?
67+
68+
The reason for not doing this is pretty simple - multi-line results don't look
69+
very good in the minibuffer and overlays. That's why there's little point in
70+
pretty-printing results there.
71+
72+
As most of the time you'll know in advance what kind of result to expect, we feel it's
73+
best to leave it to you to decide which evaluation command to use depending on the situation.
74+
****
75+
6376
== Exotic Evaluation Commands
6477

6578
NOTE: WIP

0 commit comments

Comments
 (0)