branch: elpa/cider
commit ba345e9d31cecf76cbbad74094b9720376ae9694
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Add animated gifs of macrostep, the debugger, enlighten and the inspector
Scripted captures assembled frame by frame - the debugger gif replaces
the ancient one that predates the current UI. The enlighten one shows
the behavior as fixed by cider-nrepl#1038 and cider#4114.
---
doc/modules/ROOT/assets/images/cider-debugger.gif | Bin 0 -> 73201 bytes
doc/modules/ROOT/assets/images/cider-enlighten.gif | Bin 0 -> 68656 bytes
doc/modules/ROOT/assets/images/cider-inspector.gif | Bin 0 -> 118823 bytes
doc/modules/ROOT/assets/images/cider-macrostep.gif | Bin 0 -> 52990 bytes
doc/modules/ROOT/pages/debugging/debugger.adoc | 2 +-
doc/modules/ROOT/pages/debugging/enlighten.adoc | 4 ++++
doc/modules/ROOT/pages/debugging/inspector.adoc | 2 ++
doc/modules/ROOT/pages/debugging/macroexpansion.adoc | 2 ++
8 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/doc/modules/ROOT/assets/images/cider-debugger.gif
b/doc/modules/ROOT/assets/images/cider-debugger.gif
new file mode 100644
index 0000000000..fc2dd46b0e
Binary files /dev/null and b/doc/modules/ROOT/assets/images/cider-debugger.gif
differ
diff --git a/doc/modules/ROOT/assets/images/cider-enlighten.gif
b/doc/modules/ROOT/assets/images/cider-enlighten.gif
new file mode 100644
index 0000000000..af8f615ec4
Binary files /dev/null and b/doc/modules/ROOT/assets/images/cider-enlighten.gif
differ
diff --git a/doc/modules/ROOT/assets/images/cider-inspector.gif
b/doc/modules/ROOT/assets/images/cider-inspector.gif
new file mode 100644
index 0000000000..87a98e9ca5
Binary files /dev/null and b/doc/modules/ROOT/assets/images/cider-inspector.gif
differ
diff --git a/doc/modules/ROOT/assets/images/cider-macrostep.gif
b/doc/modules/ROOT/assets/images/cider-macrostep.gif
new file mode 100644
index 0000000000..aac5fe09df
Binary files /dev/null and b/doc/modules/ROOT/assets/images/cider-macrostep.gif
differ
diff --git a/doc/modules/ROOT/pages/debugging/debugger.adoc
b/doc/modules/ROOT/pages/debugging/debugger.adoc
index 1ca614e604..22a2ad1b6e 100644
--- a/doc/modules/ROOT/pages/debugging/debugger.adoc
+++ b/doc/modules/ROOT/pages/debugging/debugger.adoc
@@ -4,7 +4,7 @@
CIDER ships with a *powerful* interactive Clojure debugger inspired by Emacs's
own
http://www.gnu.org/software/emacs/manual/html_node/elisp/Edebug.html[Edebug].
You're going to love it!
-image::cider_debugger.gif[CIDER Debugger]
+image::cider-debugger.gif[A debugger session: stepping through a function with
value overlays]
WARNING: The debugger **does not** support ClojureScript.
Check out https://github.com/jpmonettas/cider-storm[Cider Storm] if you need
to debug ClojureScript code.
diff --git a/doc/modules/ROOT/pages/debugging/enlighten.adoc
b/doc/modules/ROOT/pages/debugging/enlighten.adoc
index b2c6c71a02..f9fdeb4d37 100644
--- a/doc/modules/ROOT/pages/debugging/enlighten.adoc
+++ b/doc/modules/ROOT/pages/debugging/enlighten.adoc
@@ -12,6 +12,10 @@ kbd:[C-x C-e]. Note that kbd:[C-c C-k] won't work.
That's it! Once your code executes, the regular old buffer on the left will
turn
into the brilliant show of lights on the right.
+Here's an enlightened function lighting up as it runs with different inputs:
+
+image::cider-enlighten.gif[Enlighten showing local values inline as the code
runs]
+
|===
| Enlighten Mode Disabled | Enlighten Mode Enabled
diff --git a/doc/modules/ROOT/pages/debugging/inspector.adoc
b/doc/modules/ROOT/pages/debugging/inspector.adoc
index b1c355be31..387c3d2a16 100644
--- a/doc/modules/ROOT/pages/debugging/inspector.adoc
+++ b/doc/modules/ROOT/pages/debugging/inspector.adoc
@@ -5,6 +5,8 @@ The value inspector allows you to inspect and navigate the
structure of data. Wh
it for pretty much anything (e.g. primitive data types, var, ref types) it's
most
useful when you're dealing with (deeply) nested collection-like data types
(e.g. a vector of maps).
+image::cider-inspector.gif[Inspecting a vector of maps: table view mode and
drilling into a value]
+
== Usage
Typing kbd:[C-c M-i] (`cider-inspect`) after some form in a source
diff --git a/doc/modules/ROOT/pages/debugging/macroexpansion.adoc
b/doc/modules/ROOT/pages/debugging/macroexpansion.adoc
index e1dd0e9d9f..aa417457a0 100644
--- a/doc/modules/ROOT/pages/debugging/macroexpansion.adoc
+++ b/doc/modules/ROOT/pages/debugging/macroexpansion.adoc
@@ -168,6 +168,8 @@ a form (as with kbd:[C-x C-e]) and run `M-x
cider-macrostep-expand`: the form is
replaced by its one-step expansion and you enter a transient, read-only
`cider-macrostep-mode` with these keybindings:
+image::cider-macrostep.gif[Stepping through a macro expansion inline and
collapsing back]
+
|===
| Keyboard shortcut | Description
