Skip to content

Commit d9d7e14

Browse files
bbatsovbbatsov
committed
Update site docs
1 parent 907088c commit d9d7e14

File tree

9 files changed

+826
-779
lines changed

9 files changed

+826
-779
lines changed

‎docs/cider-nrepl/compatibility.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ <h2 id="java"><a class="anchor" href="#java"></a>Java</h2>
232232
<h2 id="clojure"><a class="anchor" href="#clojure"></a>Clojure</h2>
233233
<div class="sectionbody">
234234
<div class="paragraph">
235-
<p><code>cider-nrepl</code> targets Clojure 1.9+. As Clojure doesn&#8217;t have the concept of supported releases
235+
<p><code>cider-nrepl</code> targets Clojure 1.10+. As Clojure doesn&#8217;t have the concept of supported releases
236236
we have to get a bit creative to determine the minimum version to target.</p>
237237
</div>
238238
<div class="paragraph">
@@ -368,6 +368,12 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
368368
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
369369
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
370370
</tr>
371+
<tr>
372+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.48.0</p></td>
373+
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
374+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.10</p></td>
375+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
376+
</tr>
371377
</tbody>
372378
</table>
373379
</div>

‎docs/cider-nrepl/nrepl-api/ops.html

Lines changed: 92 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1258,6 +1258,9 @@ <h3 id="inspect-clear"><a class="anchor" href="#inspect-clear"></a><code>inspect
12581258
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
12591259
</li>
12601260
<li>
1261+
<p><code>:path</code> Printed representation of current inspector path.</p>
1262+
</li>
1263+
<li>
12611264
<p><code>:status</code> "done"</p>
12621265
</li>
12631266
<li>
@@ -1310,50 +1313,7 @@ <h3 id="inspect-def-current-value"><a class="anchor" href="#inspect-def-current-
13101313
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
13111314
</li>
13121315
<li>
1313-
<p><code>:status</code> "done"</p>
1314-
</li>
1315-
<li>
1316-
<p><code>:value</code> The inspector result. Contains a specially-formatted string that can be <code>read</code> and then rendered client-side.</p>
1317-
</li>
1318-
</ul>
1319-
</div>
1320-
</dd>
1321-
</dl>
1322-
</div>
1323-
</div>
1324-
<div class="sect2">
1325-
<h3 id="inspect-get-path"><a class="anchor" href="#inspect-get-path"></a><code>inspect-get-path</code></h3>
1326-
<div class="paragraph">
1327-
<p>Returns the path to the current position in the inspected value.</p>
1328-
</div>
1329-
<div class="dlist">
1330-
<dl>
1331-
<dt class="hdlist1">Required parameters</dt>
1332-
<dd>
1333-
<div class="ulist">
1334-
<ul>
1335-
<li>
1336-
<p><code>:session</code> The current session</p>
1337-
</li>
1338-
</ul>
1339-
</div>
1340-
</dd>
1341-
<dt class="hdlist1">Optional parameters</dt>
1342-
<dd>
1343-
<p></p>
1344-
</dd>
1345-
<dt class="hdlist1">Returns</dt>
1346-
<dd>
1347-
<div class="ulist">
1348-
<ul>
1349-
<li>
1350-
<p><code>:doc-block-tags-fragments</code> May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1351-
</li>
1352-
<li>
1353-
<p><code>:doc-first-sentence-fragments</code> May be absent. Represents the first sentence of a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1354-
</li>
1355-
<li>
1356-
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1316+
<p><code>:path</code> Printed representation of current inspector path.</p>
13571317
</li>
13581318
<li>
13591319
<p><code>:status</code> "done"</p>
@@ -1440,6 +1400,9 @@ <h3 id="inspect-next-page"><a class="anchor" href="#inspect-next-page"></a><code
14401400
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
14411401
</li>
14421402
<li>
1403+
<p><code>:path</code> Printed representation of current inspector path.</p>
1404+
</li>
1405+
<li>
14431406
<p><code>:status</code> "done"</p>
14441407
</li>
14451408
<li>
@@ -1487,6 +1450,9 @@ <h3 id="inspect-next-sibling"><a class="anchor" href="#inspect-next-sibling"></a
14871450
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
14881451
</li>
14891452
<li>
1453+
<p><code>:path</code> Printed representation of current inspector path.</p>
1454+
</li>
1455+
<li>
14901456
<p><code>:status</code> "done"</p>
14911457
</li>
14921458
<li>
@@ -1533,6 +1499,9 @@ <h3 id="inspect-pop"><a class="anchor" href="#inspect-pop"></a><code>inspect-pop
15331499
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
15341500
</li>
15351501
<li>
1502+
<p><code>:path</code> Printed representation of current inspector path.</p>
1503+
</li>
1504+
<li>
15361505
<p><code>:status</code> "done"</p>
15371506
</li>
15381507
<li>
@@ -1579,6 +1548,9 @@ <h3 id="inspect-prev-page"><a class="anchor" href="#inspect-prev-page"></a><code
15791548
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
15801549
</li>
15811550
<li>
1551+
<p><code>:path</code> Printed representation of current inspector path.</p>
1552+
</li>
1553+
<li>
15821554
<p><code>:status</code> "done"</p>
15831555
</li>
15841556
<li>
@@ -1626,6 +1598,9 @@ <h3 id="inspect-previous-sibling"><a class="anchor" href="#inspect-previous-sibl
16261598
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
16271599
</li>
16281600
<li>
1601+
<p><code>:path</code> Printed representation of current inspector path.</p>
1602+
</li>
1603+
<li>
16291604
<p><code>:status</code> "done"</p>
16301605
</li>
16311606
<li>
@@ -1675,6 +1650,9 @@ <h3 id="inspect-push"><a class="anchor" href="#inspect-push"></a><code>inspect-p
16751650
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
16761651
</li>
16771652
<li>
1653+
<p><code>:path</code> Printed representation of current inspector path.</p>
1654+
</li>
1655+
<li>
16781656
<p><code>:status</code> "done"</p>
16791657
</li>
16801658
<li>
@@ -1721,6 +1699,9 @@ <h3 id="inspect-refresh"><a class="anchor" href="#inspect-refresh"></a><code>ins
17211699
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
17221700
</li>
17231701
<li>
1702+
<p><code>:path</code> Printed representation of current inspector path.</p>
1703+
</li>
1704+
<li>
17241705
<p><code>:status</code> "done"</p>
17251706
</li>
17261707
<li>
@@ -1770,6 +1751,9 @@ <h3 id="inspect-set-max-atom-length"><a class="anchor" href="#inspect-set-max-at
17701751
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
17711752
</li>
17721753
<li>
1754+
<p><code>:path</code> Printed representation of current inspector path.</p>
1755+
</li>
1756+
<li>
17731757
<p><code>:status</code> "done"</p>
17741758
</li>
17751759
<li>
@@ -1819,6 +1803,61 @@ <h3 id="inspect-set-max-coll-size"><a class="anchor" href="#inspect-set-max-coll
18191803
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
18201804
</li>
18211805
<li>
1806+
<p><code>:path</code> Printed representation of current inspector path.</p>
1807+
</li>
1808+
<li>
1809+
<p><code>:status</code> "done"</p>
1810+
</li>
1811+
<li>
1812+
<p><code>:value</code> The inspector result. Contains a specially-formatted string that can be <code>read</code> and then rendered client-side.</p>
1813+
</li>
1814+
</ul>
1815+
</div>
1816+
</dd>
1817+
</dl>
1818+
</div>
1819+
</div>
1820+
<div class="sect2">
1821+
<h3 id="inspect-set-max-nested-depth"><a class="anchor" href="#inspect-set-max-nested-depth"></a><code>inspect-set-max-nested-depth</code></h3>
1822+
<div class="paragraph">
1823+
<p>Set the maximum nested levels to display before truncating.</p>
1824+
</div>
1825+
<div class="dlist">
1826+
<dl>
1827+
<dt class="hdlist1">Required parameters</dt>
1828+
<dd>
1829+
<div class="ulist">
1830+
<ul>
1831+
<li>
1832+
<p><code>:max-nested-depth</code> New nested depth.</p>
1833+
</li>
1834+
<li>
1835+
<p><code>:session</code> The current session</p>
1836+
</li>
1837+
</ul>
1838+
</div>
1839+
</dd>
1840+
<dt class="hdlist1">Optional parameters</dt>
1841+
<dd>
1842+
<p></p>
1843+
</dd>
1844+
<dt class="hdlist1">Returns</dt>
1845+
<dd>
1846+
<div class="ulist">
1847+
<ul>
1848+
<li>
1849+
<p><code>:doc-block-tags-fragments</code> May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1850+
</li>
1851+
<li>
1852+
<p><code>:doc-first-sentence-fragments</code> May be absent. Represents the first sentence of a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1853+
</li>
1854+
<li>
1855+
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
1856+
</li>
1857+
<li>
1858+
<p><code>:path</code> Printed representation of current inspector path.</p>
1859+
</li>
1860+
<li>
18221861
<p><code>:status</code> "done"</p>
18231862
</li>
18241863
<li>
@@ -1868,6 +1907,9 @@ <h3 id="inspect-set-page-size"><a class="anchor" href="#inspect-set-page-size"><
18681907
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
18691908
</li>
18701909
<li>
1910+
<p><code>:path</code> Printed representation of current inspector path.</p>
1911+
</li>
1912+
<li>
18711913
<p><code>:status</code> "done"</p>
18721914
</li>
18731915
<li>
@@ -1914,6 +1956,9 @@ <h3 id="inspect-tap-current-value"><a class="anchor" href="#inspect-tap-current-
19141956
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
19151957
</li>
19161958
<li>
1959+
<p><code>:path</code> Printed representation of current inspector path.</p>
1960+
</li>
1961+
<li>
19171962
<p><code>:status</code> "done"</p>
19181963
</li>
19191964
<li>
@@ -1963,6 +2008,9 @@ <h3 id="inspect-tap-indexed"><a class="anchor" href="#inspect-tap-indexed"></a><
19632008
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
19642009
</li>
19652010
<li>
2011+
<p><code>:path</code> Printed representation of current inspector path.</p>
2012+
</li>
2013+
<li>
19662014
<p><code>:status</code> "done"</p>
19672015
</li>
19682016
<li>

‎docs/cider-nrepl/nrepl-api/supplied_middleware.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ <h1 class="page">Supplied nREPL middleware</h1>
296296
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wrap-inspect</code></p></td>
297297
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
298298
<td class="tableblock halign-left valign-top"><p class="tableblock">No</p></td>
299-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>inspect-(start/refresh/pop/push/reset/get-path)</code></p></td>
299+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>inspect-(start/refresh/pop/push)</code></p></td>
300300
<td class="tableblock halign-left valign-top"><p class="tableblock">Inspect a Clojure expression.</p></td>
301301
</tr>
302302
<tr>

‎docs/cider-nrepl/usage.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -326,18 +326,6 @@ <h3 id="via-boot"><a class="anchor" href="#via-boot"></a>Via Boot</h3>
326326
<div class="sect1">
327327
<h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
328328
<div class="sectionbody">
329-
<div class="admonitionblock note">
330-
<table>
331-
<tr>
332-
<td class="icon">
333-
<i class="fa icon-note" title="Note"></i>
334-
</td>
335-
<td class="content">
336-
<code>clj</code> was introduced in Clojure 1.9.
337-
</td>
338-
</tr>
339-
</table>
340-
</div>
341329
<div class="paragraph">
342330
<p>You can easily boot an nREPL server with the CIDER middleware loaded
343331
with the following "magic" incantation:</p>

‎docs/cider/about/compatibility.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ <h2 id="java"><a class="anchor" href="#java"></a>Java</h2>
489489
<h2 id="clojure"><a class="anchor" href="#clojure"></a>Clojure</h2>
490490
<div class="sectionbody">
491491
<div class="paragraph">
492-
<p>CIDER targets Clojure 1.9+. As Clojure doesn&#8217;t have the concept of supported releases
492+
<p>CIDER targets Clojure 1.10+. As Clojure doesn&#8217;t have the concept of supported releases
493493
we have to get a bit creative to determine the minimum version to target.</p>
494494
</div>
495495
<div class="paragraph">
@@ -689,6 +689,14 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
689689
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
690690
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
691691
</tr>
692+
<tr>
693+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.14</p></td>
694+
<td class="tableblock halign-left valign-top"><p class="tableblock">26.1</p></td>
695+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0</p></td>
696+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.47</p></td>
697+
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
698+
<td class="tableblock halign-left valign-top"><p class="tableblock">1.10</p></td>
699+
</tr>
692700
</tbody>
693701
</table>
694702
<div class="admonitionblock tip">

‎docs/cider/config/basic_config.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ <h2 id="use-enrich-classpath"><a class="anchor" href="#use-enrich-classpath"></a
505505
<div class="ulist">
506506
<ul>
507507
<li>
508-
<p>For <code>cider-connect</code>, please follow enrich-classpath&#8217;s <a href="https://github.com/clojure-emacs/enrich-classpath/tree/v1.19.0#emacs-cider-connect">own instructions</a>.</p>
508+
<p>For <code>cider-connect</code>, please follow enrich-classpath&#8217;s <a href="https://github.com/clojure-emacs/enrich-classpath/tree/v1.19.3#emacs-cider-connect">own instructions</a>.</p>
509509
</li>
510510
</ul>
511511
</div>

‎docs/cider/usage/misc_features.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -764,9 +764,6 @@ <h2 id="browsing-namespaces"><a class="anchor" href="#browsing-namespaces"></a>B
764764
<h2 id="browsing-the-clojure-spec-registry"><a class="anchor" href="#browsing-the-clojure-spec-registry"></a>Browsing the Clojure Spec Registry</h2>
765765
<div class="sectionbody">
766766
<div class="paragraph">
767-
<p>If you are using Clojure 1.9 or newer you can browse the Clojure spec registry.</p>
768-
</div>
769-
<div class="paragraph">
770767
<p>If you already know which spec you&#8217;re looking for, you can type
771768
<kbd>M-x</kbd> <code>cider-browse-spec</code> and CIDER will prompt you for a
772769
spec name and then drop you into the spec browser.</p>

0 commit comments

Comments
 (0)