Skip to content

Commit 16f0210

Browse files
Update docs
1 parent 1bd1f45 commit 16f0210

File tree

3 files changed

+6
-109
lines changed

3 files changed

+6
-109
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## master (unreleased)
44

5+
* Bump `orchard` to [0.31.0](https://github.com/clojure-emacs/orchard/blob/master/CHANGELOG.md#0310-2025-03-14).
6+
- Info: recognize printed Java classes/methods and munged Clojure functions in stacktrace outputs.
7+
- Add dedicated renderers for exceptions in inspector and debugger.
8+
* [#919](https://github.com/clojure-emacs/cider-nrepl/pull/919): Move exception analysis to Orchard.
9+
- **BREAKING**: Remove `analyze-stacktrace` and `cider/log-analyze-stacktrace` ops.
10+
- Stop vendoring Haystack dependency.
511
* [#913](https://github.com/clojure-emacs/cider-nrepl/pull/913): Disable background warmup of `orchard.java` cache.
612
* [#913](https://github.com/clojure-emacs/cider-nrepl/pull/913): Enable background warmup of Compliment cache.
713
* [#914](https://github.com/clojure-emacs/cider-nrepl/pull/914): Remove javadoc section from the inspector output.

doc/modules/ROOT/pages/nrepl-api/ops.adoc

-69
Original file line numberDiff line numberDiff line change
@@ -29,57 +29,6 @@ Returns::
2929

3030

3131

32-
=== `analyze-stacktrace`
33-
34-
Parse and analyze the ``:stacktrace``
35-
parameter and return messages describing each cause and stack frame. The
36-
stacktrace must be a string formatted in one of the following formats:
37-
38-
* ``:aviso`` Stacktraces printed with the
39-
https://ioavisopretty.readthedocs.io/en/latest/exceptions.html[write-exception]
40-
function of the https://github.com/AvisoNovate/pretty[Aviso] library.
41-
42-
* ``:clojure.tagged-literal`` Stacktraces printed as a tagged literal, like a
43-
https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html[java.lang.Throwable]
44-
printed with the
45-
https://clojure.github.io/clojure/branch-master/clojure.core-api.html#clojure.core/pr[pr]
46-
function.
47-
48-
* ``:clojure.stacktrace`` Stacktraces printed with the
49-
https://clojure.github.io/clojure/branch-master/clojure.stacktrace-api.html#clojure.stacktrace/print-cause-trace[print-cause-trace]
50-
function of the
51-
https://clojure.github.io/clojure/branch-master/clojure.stacktrace-api.html[clojure.stacktrace]
52-
namespace.
53-
54-
* ``:clojure.repl`` Stacktraces printed with the
55-
https://clojure.github.io/clojure/branch-master/clojure.repl-api.html#clojure.repl/pst[pst]
56-
function of the
57-
https://clojure.github.io/clojure/branch-master/clojure.repl-api.html[clojure.repl]
58-
namespace.
59-
60-
* ``:java`` Stacktraces printed with the
61-
link:++https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#printStackTrace--++[printStackTrace]
62-
method of
63-
https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html[java.lang.Throwable].
64-
65-
Required parameters::
66-
* `:stacktrace` The stacktrace to be parsed and analyzed as a string.
67-
68-
69-
Optional parameters::
70-
* `:nrepl.middleware.print/buffer-size` The size of the buffer to use when streaming results. Defaults to 1024.
71-
* `:nrepl.middleware.print/keys` A seq of the keys in the response whose values should be printed.
72-
* `:nrepl.middleware.print/options` A map of options to pass to the printing function. Defaults to ``nil``.
73-
* `:nrepl.middleware.print/print` A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
74-
* `:nrepl.middleware.print/quota` A hard limit on the number of bytes printed for each value.
75-
* `:nrepl.middleware.print/stream?` If logical true, the result of printing each value will be streamed to the client over one or more messages.
76-
77-
78-
Returns::
79-
* `:status` "done", or "no-error" if ``stracktrace`` is not recognized
80-
81-
82-
8332
=== `apropos`
8433

8534
Return a sequence of vars whose name matches the query pattern, or if specified, having the pattern in their docstring.
@@ -1521,24 +1470,6 @@ Returns::
15211470

15221471

15231472

1524-
=== `cider/log-analyze-stacktrace`
1525-
1526-
Analyze the stacktrace of a log event.
1527-
1528-
Required parameters::
1529-
* `:appender` The name of the appender.
1530-
* `:event` The id of the event to inspect.
1531-
* `:framework` The id of the log framework.
1532-
1533-
1534-
Optional parameters::
1535-
{blank}
1536-
1537-
Returns::
1538-
* `:status` done
1539-
1540-
1541-
15421473
=== `cider/log-clear-appender`
15431474

15441475
Clear all events of a log appender.

src/cider/nrepl.clj

-40
Original file line numberDiff line numberDiff line change
@@ -415,13 +415,6 @@ if applicable, and re-render the updated value."
415415
:returns {"status" "done"
416416
"cider/log-add-consumer" "The consumer that was added."}}
417417

418-
"cider/log-analyze-stacktrace"
419-
{:doc "Analyze the stacktrace of a log event."
420-
:requires {"framework" "The id of the log framework."
421-
"appender" "The name of the appender."
422-
"event" "The id of the event to inspect."}
423-
:returns {"status" "done"}}
424-
425418
"cider/log-clear-appender"
426419
{:doc "Clear all events of a log appender."
427420
:requires {"framework" "The id of the log framework."
@@ -708,39 +701,6 @@ Assumes that `analyze-last-stacktrace` has been called first, returning \"no-err
708701
:requires {"index" "0 for inspecting the top-level exception, 1 for its ex-cause, 2 for its ex-cause's ex-cause, and so on."}
709702
:returns {"status" "\"done\", or \"no-error\" if `analyze-last-stacktrace` wasn't called beforehand (or the `index` was out of bounds)."
710703
"value" "A value, as produced by the Inspector middleware."}}
711-
"analyze-stacktrace" {:doc "Parse and analyze the `:stacktrace`
712-
parameter and return messages describing each cause and stack frame. The
713-
stacktrace must be a string formatted in one of the following formats:
714-
715-
* `:aviso` Stacktraces printed with the
716-
https://ioavisopretty.readthedocs.io/en/latest/exceptions.html[write-exception]
717-
function of the https://github.com/AvisoNovate/pretty[Aviso] library.
718-
719-
* `:clojure.tagged-literal` Stacktraces printed as a tagged literal, like a
720-
https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html[java.lang.Throwable]
721-
printed with the
722-
https://clojure.github.io/clojure/branch-master/clojure.core-api.html#clojure.core/pr[pr]
723-
function.
724-
725-
* `:clojure.stacktrace` Stacktraces printed with the
726-
https://clojure.github.io/clojure/branch-master/clojure.stacktrace-api.html#clojure.stacktrace/print-cause-trace[print-cause-trace]
727-
function of the
728-
https://clojure.github.io/clojure/branch-master/clojure.stacktrace-api.html[clojure.stacktrace]
729-
namespace.
730-
731-
* `:clojure.repl` Stacktraces printed with the
732-
https://clojure.github.io/clojure/branch-master/clojure.repl-api.html#clojure.repl/pst[pst]
733-
function of the
734-
https://clojure.github.io/clojure/branch-master/clojure.repl-api.html[clojure.repl]
735-
namespace.
736-
737-
* `:java` Stacktraces printed with the
738-
link:++https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#printStackTrace--++[printStackTrace]
739-
method of
740-
https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html[java.lang.Throwable]."
741-
:requires {"stacktrace" "The stacktrace to be parsed and analyzed as a string."}
742-
:optional wrap-print-optional-arguments
743-
:returns {"status" "\"done\", or \"no-error\" if `stracktrace` is not recognized"}}
744704
"stacktrace" {:doc "Return messages describing each cause and
745705
stack frame of the most recent exception. This op is deprecated, please use the
746706
`analyze-last-stacktrace` op instead."

0 commit comments

Comments
 (0)