Skip to content

Commit b4e1e6c

Browse files
committed
Regenerate the ops docs
1 parent 9c86002 commit b4e1e6c

File tree

1 file changed

+14
-11
lines changed
  • doc/modules/ROOT/pages/nrepl-api

1 file changed

+14
-11
lines changed

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file is _generated_ by #'cider.nrepl.impl.docs/-main
44
////
55
= Supported nREPL operations
66
7-
[small]#generated from a verbose 'describe' response (cider-nrepl v0.24.0)#
7+
[small]#generated from a verbose 'describe' response (cider-nrepl v0.25.0-SNAPSHOT)#
88

99
== Operations
1010

@@ -111,9 +111,9 @@ Returns::
111111
Return a list of symbols matching the specified (partial) symbol.
112112

113113
Required parameters::
114-
* `:ns` The symbol's namespace
114+
* `:ns` The namespace is which to look for completions (falls back to \*ns* if not specified)
115+
* `:prefix` The prefix for completion candidates
115116
* `:session` The current session
116-
* `:symbol` The symbol to lookup
117117

118118

119119
Optional parameters::
@@ -132,7 +132,7 @@ Retrieve documentation suitable for display in completion popup
132132

133133
Required parameters::
134134
* `:ns` The symbol's namespace
135-
* `:symbol` The symbol to lookup
135+
* `:sym` The symbol to lookup
136136

137137

138138
Optional parameters::
@@ -230,7 +230,7 @@ Return a map of information about the specified symbol.
230230

231231
Required parameters::
232232
* `:ns` The current namespace
233-
* `:symbol` The symbol to lookup
233+
* `:sym` The symbol to lookup
234234

235235

236236
Optional parameters::
@@ -247,7 +247,7 @@ Return a map containing the inputs of the datomic query.
247247

248248
Required parameters::
249249
* `:ns` The current namespace
250-
* `:symbol` The symbol to lookup
250+
* `:sym` The symbol to lookup
251251

252252

253253
Optional parameters::
@@ -355,7 +355,7 @@ Return a map of information about the specified symbol.
355355

356356
Required parameters::
357357
* `:ns` The current namespace
358-
* `:symbol` The symbol to lookup
358+
* `:sym` The symbol to lookup
359359

360360

361361
Optional parameters::
@@ -1032,7 +1032,8 @@ Returns::
10321032
Run tests specified by the ``var-query`` and return results. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
10331033

10341034
Required parameters::
1035-
{blank}
1035+
* `:var-query` A search query specifying the test vars to execute. See Orchard's var query documentation for more details.
1036+
10361037

10371038
Optional parameters::
10381039
* `:nrepl.middleware.print/buffer-size` The size of the buffer to use when streaming results. Defaults to 1024.
@@ -1044,7 +1045,9 @@ Optional parameters::
10441045

10451046

10461047
Returns::
1047-
{blank}
1048+
* `:results` A map of test run data.
1049+
* `:status` Either done or indication of an error
1050+
10481051

10491052

10501053
=== `toggle-profile`
@@ -1135,8 +1138,8 @@ Returns::
11351138
Undefine a symbol
11361139

11371140
Required parameters::
1138-
* `:ns` The current namespace
1139-
* `:symbol` The symbol to undefine
1141+
* `:ns` The namespace is which to resolve sym (falls back to \*ns* if not specified)
1142+
* `:sym` The symbol to undefine
11401143

11411144

11421145
Optional parameters::

0 commit comments

Comments
 (0)