Skip to content

Commit 85106c4

Browse files
committed
Update site docs
1 parent 702d819 commit 85106c4

File tree

11 files changed

+1087
-1073
lines changed

11 files changed

+1087
-1073
lines changed

docs/_/css/site.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_/js/site.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/cider-nrepl/compatibility.html

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -362,19 +362,13 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
362362
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
363363
</tr>
364364
<tr>
365-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.44.0</p></td>
366-
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
367-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
368-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
369-
</tr>
370-
<tr>
371365
<td class="tableblock halign-left valign-top"><p class="tableblock">0.47.0</p></td>
372366
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
373367
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
374368
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
375369
</tr>
376370
<tr>
377-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.49.0</p></td>
371+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.50.0</p></td>
378372
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
379373
<td class="tableblock halign-left valign-top"><p class="tableblock">1.10</p></td>
380374
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>

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

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,9 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
11561156
<div class="paragraph">
11571157
<p>Return a map of information about the specified symbol.</p>
11581158
</div>
1159+
<div class="paragraph">
1160+
<p>Note: Documentation may be incomplete; not all return keys are described.</p>
1161+
</div>
11591162
<div class="dlist">
11601163
<dl>
11611164
<dt class="hdlist1">Required parameters</dt>
@@ -1197,6 +1200,12 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
11971200
<div class="ulist">
11981201
<ul>
11991202
<li>
1203+
<p><code>:arglists-str</code> The arguments list(s) accepted by the symbol, as a string, if applicable.</p>
1204+
</li>
1205+
<li>
1206+
<p><code>:column</code> The column number where the symbol is defined.</p>
1207+
</li>
1208+
<li>
12001209
<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>
12011210
</li>
12021211
<li>
@@ -1206,6 +1215,18 @@ <h3 id="info"><a class="anchor" href="#info"></a><code>info</code></h3>
12061215
<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>
12071216
</li>
12081217
<li>
1218+
<p><code>:file</code> Either a URI or a relative path where the symbol is defined.</p>
1219+
</li>
1220+
<li>
1221+
<p><code>:line</code> The line number the symbol is defined.</p>
1222+
</li>
1223+
<li>
1224+
<p><code>:name</code> The unqualified name of the symbol.</p>
1225+
</li>
1226+
<li>
1227+
<p><code>:ns</code> The namespace the symbol belongs to.</p>
1228+
</li>
1229+
<li>
12091230
<p><code>:status</code> done</p>
12101231
</li>
12111232
</ul>
@@ -2173,7 +2194,7 @@ <h3 id="macroexpand"><a class="anchor" href="#macroexpand"></a><code>macroexpand
21732194
<p><code>:display-namespaces</code> How to print namespace-qualified symbols in the result. Possible values are "qualified" to leave all namespaces qualified, "none" to elide all namespaces, or "tidy" to replace namespaces with their aliases in the given namespace. Defaults to "qualified".</p>
21742195
</li>
21752196
<li>
2176-
<p><code>:expander</code> The macroexpansion function to use. Possible values are "macroexpand-1", "macroexpand", or "macroexpand-all". Defaults to "macroexpand".</p>
2197+
<p><code>:expander</code> The macroexpansion function to use. Possible values are "macroexpand-1", "macroexpand", "macroexpand-step", or "macroexpand-all". Defaults to "macroexpand".</p>
21772198
</li>
21782199
<li>
21792200
<p><code>:ns</code> The namespace in which to perform the macroexpansion. Defaults to 'user for Clojure and 'cljs.user for ClojureScript.</p>

docs/cider-nrepl/usage.html

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -240,11 +240,10 @@ <h1 class="page">Usage</h1>
240240
<h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2>
241241
<div class="sectionbody">
242242
<div class="paragraph">
243-
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.9+ and Java 8+.</p>
243+
<p><code>cider-nrepl</code> supports only Clojure(Script) 1.10+ and Java 8+.</p>
244244
</div>
245245
<div class="paragraph">
246-
<p>Leiningen users will need to have version 2.8.3 or newer installed.
247-
Boot users will need to have version 2.8.2 or newer installed.</p>
246+
<p>Leiningen users will need to have version 2.8.3 or newer installed.</p>
248247
</div>
249248
</div>
250249
</div>
@@ -258,15 +257,15 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
258257
</div>
259258
<div class="listingblock">
260259
<div class="content">
261-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.49.0"]]</code></pre>
260+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:plugins [[cider/cider-nrepl "0.50.0"]]</code></pre>
262261
</div>
263262
</div>
264263
<div class="paragraph">
265264
<p>A minimal <code>profiles.clj</code> for CIDER would be:</p>
266265
</div>
267266
<div class="listingblock">
268267
<div class="content">
269-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:user {:plugins [[cider/cider-nrepl "0.49.0"]]}}</code></pre>
268+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{:user {:plugins [[cider/cider-nrepl "0.50.0"]]}}</code></pre>
270269
</div>
271270
</div>
272271
<div class="paragraph">
@@ -276,7 +275,7 @@ <h2 id="via-leiningen"><a class="anchor" href="#via-leiningen"></a>Via Leiningen
276275
</div>
277276
<div class="listingblock">
278277
<div class="content">
279-
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.49.0"]]
278+
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">:dependencies [[cider/cider-nrepl "0.50.0"]]
280279
:repl-options {:nrepl-middleware
281280
[cider.nrepl/wrap-apropos
282281
cider.nrepl/wrap-classpath
@@ -314,7 +313,7 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
314313
</div>
315314
<div class="listingblock">
316315
<div class="content">
317-
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.49.0"} }}' -M -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
316+
<pre>clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.50.0"} }}' -M -m nrepl.cmdline --middleware "[cider.nrepl/cider-middleware]"</pre>
318317
</div>
319318
</div>
320319
<div class="paragraph">
@@ -325,12 +324,12 @@ <h2 id="via-clj"><a class="anchor" href="#via-clj"></a>Via clj</h2>
325324
<pre class="highlightjs highlight"><code class="language-clojure hljs" data-lang="clojure">{...
326325
:aliases
327326
{:cider-clj {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
328-
cider/cider-nrepl {:mvn/version "0.49.0"}}
327+
cider/cider-nrepl {:mvn/version "0.50.0"}}
329328
:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}
330329

331330
:cider-cljs {:extra-deps {org.clojure/clojure {:mvn/version "1.10.3"}
332331
org.clojure/clojurescript {:mvn/version "1.10.339"}
333-
cider/cider-nrepl {:mvn/version "0.49.0"}
332+
cider/cider-nrepl {:mvn/version "0.50.0"}
334333
cider/piggieback {:mvn/version "0.5.2"}}
335334
:main-opts ["-m" "nrepl.cmdline" "--middleware"
336335
"[cider.nrepl/cider-middleware,cider.piggieback/wrap-cljs-repl]"]}}}</code></pre>

0 commit comments

Comments
 (0)