Skip to content

Commit 8c5fb8f

Browse files
committed
[Docs] Extend a bit the inspector docs
1 parent 6087a56 commit 8c5fb8f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/modules/ROOT/pages/debugging/inspector.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
= Inspector
22
:experimental:
33

4+
The value inspector allows you inspect and navigate the structure of data. While you can use
5+
it for pretty much anything (e.g. primitive data types, var, ref types) it's most
6+
useful when you're dealing with (deeply) nested collection-like data types (e.g. a vector of maps).
7+
8+
== Usage
9+
410
Typing kbd:[C-c M-i] (`cider-inspect`) after some form in a source
511
buffer or the REPL will show you the structure for the result of the
612
form in a new buffer. You can also use kbd:[C-u C-c M-i] to inspect
@@ -13,7 +19,7 @@ buffer is visible in the background, it is automatically updated with
1319
the last result. This behavior can be controlled with the variable
1420
`cider-auto-inspect-after-eval`.
1521

16-
The inspector can also be invoked in the middle of a debugging
22+
TIP: The inspector can also be invoked in the middle of a debugging
1723
session, see xref:debugger.adoc[here] for more details.
1824

1925
You'll have access to additional keybindings in the inspector buffer
@@ -51,3 +57,7 @@ You'll have access to additional keybindings in the inspector buffer
5157
By default, navigation skips over values like nils, numbers and
5258
keywords, which are not interesting to inspect. You can control this
5359
behavior using the variable `cider-inspector-skip-uninteresting`.
60+
61+
== Additional Resources
62+
63+
* https://practicalli.github.io/spacemacs/evaluating-clojure/inspect.html[Using CIDER's Inspector in Spacemacs]

0 commit comments

Comments
 (0)