Skip to content

Commit a2d7e84

Browse files
committed
Update site docs
1 parent 105e661 commit a2d7e84

File tree

8 files changed

+772
-727
lines changed

8 files changed

+772
-727
lines changed

docs/cider/basics/middleware_setup.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -481,15 +481,15 @@ <h3 id="using-leiningen"><a class="anchor" href="#using-leiningen"></a>Using Lei
481481
</div>
482482
<div class="listingblock">
483483
<div class="content">
484-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.42.1"]]</code></pre>
484+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.43.0"]]</code></pre>
485485
</div>
486486
</div>
487487
<div class="paragraph">
488488
<p>A minimal <code>profiles.clj</code> for CIDER would be:</p>
489489
</div>
490490
<div class="listingblock">
491491
<div class="content">
492-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.42.1"]]}}</code></pre>
492+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:repl {:plugins [[cider/cider-nrepl "0.43.0"]]}}</code></pre>
493493
</div>
494494
</div>
495495
<div class="admonitionblock warning">
@@ -531,7 +531,7 @@ <h3 id="using-boot"><a class="anchor" href="#using-boot"></a>Using Boot</h3>
531531
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">(require 'boot.repl)
532532

533533
(swap! boot.repl/*default-dependencies*
534-
concat '[[cider/cider-nrepl "0.42.1"]])
534+
concat '[[cider/cider-nrepl "0.43.0"]])
535535

536536
(swap! boot.repl/*default-middleware*
537537
conj 'cider.nrepl/cider-middleware)</code></pre>
@@ -551,11 +551,11 @@ <h3 id="using-tools-deps"><a class="anchor" href="#using-tools-deps"></a>Using t
551551
</div>
552552
<div class="listingblock">
553553
<div class="content">
554-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.42.1"}}
554+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure"> :cider-clj {:extra-deps {cider/cider-nrepl {:mvn/version "0.43.0"}}
555555
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
556556

557557
:cider-cljs {:extra-deps {org.clojure/clojurescript {:mvn/version "1.10.339"}
558-
cider/cider-nrepl {:mvn/version "0.42.1"}
558+
cider/cider-nrepl {:mvn/version "0.43.0"}
559559
cider/piggieback {:mvn/version "0.5.3"}}
560560
:main-opts ["-m" "nrepl.cmdline" "--middleware"
561561
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}</code></pre>
@@ -595,7 +595,7 @@ <h3 id="using-gradle"><a class="anchor" href="#using-gradle"></a>Using Gradle</h
595595
<div class="content">
596596
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
597597
devImplementation 'nrepl:nrepl:0.9.0'
598-
devImplementation 'cider:cider-nrepl:0.42.1'
598+
devImplementation 'cider:cider-nrepl:0.43.0'
599599
}
600600

601601
tasks.named('clojureRepl') {

docs/cider/basics/up_and_running.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -543,7 +543,7 @@ <h3 id="auto-injecting-dependencies"><a class="anchor" href="#auto-injecting-dep
543543
</div>
544544
<div class="literalblock">
545545
<div class="content">
546-
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.42.1"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
546+
<pre>$ clojure -Sdeps '{:deps {nrepl {:mvn/version "0.6.0"} cider/cider-nrepl {:mvn/version "0.43.0"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]'</pre>
547547
</div>
548548
</div>
549549
<div class="admonitionblock tip">
@@ -939,7 +939,7 @@ <h2 id="connect-to-a-running-nrepl-server"><a class="anchor" href="#connect-to-a
939939
</div>
940940
<div class="listingblock">
941941
<div class="content">
942-
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.42.1"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
942+
<pre class="highlightjs highlight"><code class="language-sh hljs" data-lang="sh">$ clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.43.0"}}}' -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</code></pre>
943943
</div>
944944
</div>
945945
<div class="paragraph">

docs/cider/cljs/shadow-cljs.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ <h3 id="using-cider-connect-cljs"><a class="anchor" href="#using-cider-connect-c
525525
</div>
526526
<div class="listingblock">
527527
<div class="content">
528-
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.42.1"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
528+
<pre class="highlightjs highlight"><code class="language-clj hljs" data-lang="clj"> :dependencies [[cider/cider-nrepl "0.43.0"] ;; mandatory (unless it's inherited from deps.edn or otherwise present in the classpath of shadow-cljs's JVM process)
529529
[refactor-nrepl/refactor-nrepl "3.9.0"]] ;; refactor-nrepl is optional
530530

531531
:nrepl {:middleware [cider.nrepl/cider-middleware ;; it's advisable to explicitly add this middleware. It's automatically added by shadow-cljs (if available in the classpath), unless `:nrepl {:cider false}`

docs/cider/cljs/up_and_running.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ <h3 id="manual-piggieback-setup"><a class="anchor" href="#manual-piggieback-setu
482482
<div class="content">
483483
<pre class="highlightjs highlight"><code class="language-groovy hljs" data-lang="groovy">dependencies {
484484
devImplementation 'nrepl:nrepl:0.9.0'
485-
devImplementation 'cider:cider-nrepl:0.42.1'
485+
devImplementation 'cider:cider-nrepl:0.43.0'
486486
devImplementation 'cider:cider-piggieback:0.5.3'
487487
}
488488

docs/cider/debugging/inspector.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,12 +509,12 @@ <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2>
509509
<td class="tableblock halign-left valign-top"><p class="tableblock">Refresh the inspector (e.g. if viewing an atom/ref/agent)</p></td>
510510
</tr>
511511
<tr>
512-
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>SPC</kbd></p></td>
512+
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>SPC</kbd> or <kbd>Next</kbd></p></td>
513513
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cider-inspector-next-page</code></p></td>
514514
<td class="tableblock halign-left valign-top"><p class="tableblock">Jump to next page in paginated view</p></td>
515515
</tr>
516516
<tr>
517-
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>M-SPC</kbd></p></td>
517+
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>M-SPC</kbd> or <kbd>Prev</kbd></p></td>
518518
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>cider-inspector-prev-page</code></p></td>
519519
<td class="tableblock halign-left valign-top"><p class="tableblock">Jump to previous page in paginated view</p></td>
520520
</tr>
@@ -558,6 +558,15 @@ <h2 id="usage"><a class="anchor" href="#usage"></a>Usage</h2>
558558
</div>
559559
</div>
560560
<div class="sect1">
561+
<h2 id="use-enrich-classpath-for-best-results"><a class="anchor" href="#use-enrich-classpath-for-best-results"></a>Use <code>enrich-classpath</code> for best results</h2>
562+
<div class="sectionbody">
563+
<div class="paragraph">
564+
<p>If <a href="../config/basic_config.html#use-enrich-classpath" class="xref page">enrich-classpath</a> is activated, inspecting a Java class, method or field
565+
will richly display its Java doc comment documentation at the bottom of the inspector.</p>
566+
</div>
567+
</div>
568+
</div>
569+
<div class="sect1">
561570
<h2 id="configuration"><a class="anchor" href="#configuration"></a>Configuration</h2>
562571
<div class="sectionbody">
563572
<div class="paragraph">

docs/cider/usage/dealing_with_errors.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -841,6 +841,42 @@ <h4 id="limitations"><a class="anchor" href="#limitations"></a>Limitations</h4>
841841
</div>
842842
</div>
843843
</div>
844+
<div class="sect1">
845+
<h2 id="inspector-integration"><a class="anchor" href="#inspector-integration"></a>Inspector integration</h2>
846+
<div class="sectionbody">
847+
<div class="paragraph">
848+
<p>Within <code><strong>cider-error</strong></code>, when clicking directly a top-level exception (any of them in the cause chain),
849+
that specific exception will be inspected with the CIDER <a href="../debugging/inspector.html" class="xref page">Inspector</a>.</p>
850+
</div>
851+
<div class="paragraph">
852+
<p>This allows you to better understand intrincate <code>ex-data</code>.</p>
853+
</div>
854+
<div class="paragraph">
855+
<p>This clicking is defined and customizable in <code>cider-stacktrace-exception-map</code>, which has the following defaults:</p>
856+
</div>
857+
<div class="sect2">
858+
<h3 id="keybindings-2"><a class="anchor" href="#keybindings-2"></a>Keybindings</h3>
859+
<table class="tableblock frame-all grid-all stretch">
860+
<colgroup>
861+
<col style="width: 50%;">
862+
<col style="width: 50%;">
863+
</colgroup>
864+
<thead>
865+
<tr>
866+
<th class="tableblock halign-left valign-top">Action</th>
867+
<th class="tableblock halign-left valign-top">Description</th>
868+
</tr>
869+
</thead>
870+
<tbody>
871+
<tr>
872+
<td class="tableblock halign-left valign-top"><p class="tableblock"><kbd>click</kbd> or <kbd>i</kbd> or <kbd>p</kbd></p></td>
873+
<td class="tableblock halign-left valign-top"><p class="tableblock">Open the given exception in the Inspector.</p></td>
874+
</tr>
875+
</tbody>
876+
</table>
877+
</div>
878+
</div>
879+
</div>
844880
<nav class="pagination">
845881
<span class="prev"><a href="pretty_printing.html">Pretty Printing</a></span>
846882
<span class="next"><a href="working_with_documentation.html">Working with Documentation</a></span>

0 commit comments

Comments
 (0)