Skip to content

Commit abf49a0

Browse files
[docs] Update inspector docs
1 parent 504e40a commit abf49a0

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

CHANGELOG.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,33 @@
22

33
## master (unreleased)
44

5+
### New features
6+
7+
- [#3802](https://github.com/clojure-emacs/cider/issues/3802): Inspector analytics.
8+
- [#3802](https://github.com/clojure-emacs/cider/issues/3802): Inspector table view-mode.
9+
- [orchard#320](https://github.com/clojure-emacs/orchard/pull/320): Info: recognize printed Java classes/methods and munged Clojure functions in stacktrace outputs.
10+
511
### Changes
612

713
- [#3782](https://github.com/clojure-emacs/cider/issues/3782): **(Breaking)** Drop official support for Emacs 26.
814
- [#3793](https://github.com/clojure-emacs/cider/issues/3793): **(Breaking)** Remove features that relied on printed exception parsing:
915
- `cider-stacktrace-analyze-string` and `cider-stacktrace-analyze-at-point` functions.
1016
- Automatic stacktrace parsing in log viewer.
1117
- Bump the injected `cider-nrepl` to [0.54.0](https://github.com/clojure-emacs/cider-nrepl/blob/master/CHANGELOG.md#0540-2025-04-05).
12-
- Info: recognize printed Java classes/methods and munged Clojure functions in stacktrace outputs.
18+
- [compliment#122](https://github.com/alexander-yakushev/compliment/pull/122): Completion: sort candidates by priority.
1319
- Inspector: add dedicated view for Exceptions.
1420
- Stop vendoring Haystack dependency.
15-
- Stop vendoring Puget dependency. You can still user `puget` pretty-printing for CIDER, but you need to depend on Puget explicitly. If Puget is not found on the classpath, CIDER will revert to `clojure.pprint/pprint` for pretty-printing.
21+
- Stop vendoring Puget dependency. You can still use `puget` pretty-printer in CIDER, but you need to depend on Puget explicitly. If Puget is not found on the classpath, CIDER will revert to `clojure.pprint/pprint` for pretty-printing.
1622
- [#3777](https://github.com/clojure-emacs/cider/issues/3777): Inspector no longer displays parsed Javadoc for Java classes and members.
17-
- [#3784](https://github.com/clojure-emacs/cider/issues/3784): Inspector: make point less erratic when navigating between inspector screens.
1823
- [#3790](https://github.com/clojure-emacs/cider/issues/3790): Stacktrace: show messages and data for all exception causes by default.
1924
- [#3789](https://github.com/clojure-emacs/cider/issues/3789): Refactor and simplify exception handling.
2025
- [#3789](https://github.com/clojure-emacs/cider/issues/3796): Completion: disable client-side sorting (defer to backend-provided candidate order).
2126
- [#3797](https://github.com/clojure-emacs/cider/issues/3797): Completion: enable `cider-completion-style` by default (this enables richer completion suggestions where candidates don't have to strictly match the prefix).
2227

28+
### Bugs fixed
29+
30+
- [#3784](https://github.com/clojure-emacs/cider/issues/3784): Inspector: make point less erratic when navigating between inspector screens.
31+
2332
## 1.17.1 (2025-02-25)
2433

2534
### Changes

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ You'll have access to additional keybindings in the inspector buffer
3636
| `cider-inspector-next-inspectable-object`
3737
| Navigate inspectable sub-objects
3838

39-
| kbd:[f] and kbd:[b]
40-
| `forward-char`, `backward-char`
41-
| Navigate across characters on a line
42-
4339
| kbd:[Return]
4440
| `cider-inspector-operate-on-point`
4541
| Inspect sub-objects
@@ -52,14 +48,18 @@ You'll have access to additional keybindings in the inspector buffer
5248
| `cider-inspector-refresh`
5349
| Refresh the inspector (e.g. if viewing an atom/ref/agent)
5450

55-
| kbd:[SPC] or kbd:[Next]
51+
| kbd:[SPC] or kbd:[Next]
5652
| `cider-inspector-next-page`
5753
| Jump to next page in paginated view
5854

5955
| kbd:[M-SPC] or kbd:[Prev]
6056
| `cider-inspector-prev-page`
6157
| Jump to previous page in paginated view
6258

59+
| kbd:[y]
60+
| `cider-inspector-display-analytics`
61+
| Calculate and display analytics for the inspected object. Analytics is supported for lists of numbers, strings, tuples, maps; for large key-value maps.
62+
6363
| kbd:[s]
6464
| `cider-inspector-set-page-size`
6565
| Set a new page size in paginated view
@@ -78,7 +78,8 @@ You'll have access to additional keybindings in the inspector buffer
7878

7979
| kbd:[v]
8080
| `cider-inspector-toggle-view-mode`
81-
| Switch the rendering of the current value between `:normal` and `:object` view mode. In `:object` mode, any value is rendered as a plain Java object (by displaying its fields) instead of custom rendering rules that the Inspector applies in `:normal` mode.
81+
| Switch the rendering of the current value between `:normal`, `:table`, and
82+
`:object` view modes. In `:table` mode, render the value as a table (only supported for sequences of maps or tuples). In `:object` mode, any value is rendered as a plain Java object (by displaying its fields) instead of custom rendering rules that the Inspector applies in `:normal` mode.
8283

8384
| kbd:[d]
8485
| `cider-inspector-def-current-val`

0 commit comments

Comments
 (0)