Skip to content

Commit

Permalink
Update middleware docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexander-yakushev
alexander-yakushev committed May 30, 2024
1 parent 57e3ac0 commit ba445ca
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 15 deletions.
21 changes: 13 additions & 8 deletions doc/modules/ROOT/pages/nrepl-api/ops.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -675,14 +675,19 @@ Returns::

=== `inspect-refresh`

Re-renders the currently inspected value.
Updates inspector with the provided config and re-renders the current value.

Required parameters::
* `:session` The current session


Optional parameters::
{blank}
* `:max-atom-length` New max length of single rendered value
* `:max-coll-size` New max size of rendered collection
* `:max-nested-depth` New max nested depth of rendered collection
* `:page-size` New page size
* `:view-mode` Mode of viewing the value - either "normal" or "object"


Returns::
* `:doc-block-tags-fragments` May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It's a vector of fragments, where fragment is a map with ``:type`` ('text' or 'html') and ``:content`` plain text or html markup, respectively
Expand All @@ -696,7 +701,7 @@ Returns::

=== `inspect-set-max-atom-length`

Set the max length of nested atoms to specified value.
[DEPRECATED - use ``inspect-refresh`` instead] Set the max length of nested atoms to specified value.

Required parameters::
* `:max-atom-length` New max length.
Expand All @@ -718,7 +723,7 @@ Returns::

=== `inspect-set-max-coll-size`

Set the number of nested collection members to display before truncating.
[DEPRECATED - use ``inspect-refresh`` instead] Set the number of nested collection members to display before truncating.

Required parameters::
* `:max-coll-size` New collection size.
Expand All @@ -740,7 +745,7 @@ Returns::

=== `inspect-set-max-nested-depth`

Set the maximum nested levels to display before truncating.
[DEPRECATED - use ``inspect-refresh`` instead] Set the maximum nested levels to display before truncating.

Required parameters::
* `:max-nested-depth` New nested depth.
Expand All @@ -762,7 +767,7 @@ Returns::

=== `inspect-set-page-size`

Sets the page size in paginated view to specified value.
[DEPRECATED - use ``inspect-refresh`` instead] Sets the page size in paginated view to specified value.

Required parameters::
* `:page-size` New page size.
Expand Down Expand Up @@ -1147,7 +1152,7 @@ Returns::

=== `retest`

[DEPRECATED - ``use test-var-query`` instead] Run all tests in the project. If ``load?`` is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
[DEPRECATED - use ``test-var-query`` instead] Run all tests in the project. If ``load?`` is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.

Required parameters::
{blank}
Expand Down Expand Up @@ -1281,7 +1286,7 @@ Returns::

=== `test`

[DEPRECATED - ``use test-var-query`` instead] Run tests in the specified namespace and return results. This accepts a set of ``tests`` to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
[DEPRECATED - use ``test-var-query`` instead] Run tests in the specified namespace and return results. This accepts a set of ``tests`` to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests.

Required parameters::
{blank}
Expand Down
19 changes: 12 additions & 7 deletions src/cider/nrepl.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -335,8 +335,13 @@ if applicable, and re-render the updated value."
:requires {"session" "The current session"}
:returns inspector-returns}
"inspect-refresh"
{:doc "Re-renders the currently inspected value."
{:doc "Updates inspector with the provided config and re-renders the current value."
:requires {"session" "The current session"}
:optional {"page-size" "New page size"
"max-atom-length" "New max length of single rendered value"
"max-coll-size" "New max size of rendered collection"
"max-nested-depth" "New max nested depth of rendered collection"
"view-mode" "Mode of viewing the value - either \"normal\" or \"object\""}
:returns inspector-returns}
"inspect-next-page"
{:doc "Jumps to the next page in paginated collection view."
Expand All @@ -347,22 +352,22 @@ if applicable, and re-render the updated value."
:requires {"session" "The current session"}
:returns inspector-returns}
"inspect-set-page-size"
{:doc "Sets the page size in paginated view to specified value."
{:doc "[DEPRECATED - use `inspect-refresh` instead] Sets the page size in paginated view to specified value."
:requires {"page-size" "New page size."
"session" "The current session"}
:returns inspector-returns}
"inspect-set-max-atom-length"
{:doc "Set the max length of nested atoms to specified value."
{:doc "[DEPRECATED - use `inspect-refresh` instead] Set the max length of nested atoms to specified value."
:requires {"max-atom-length" "New max length."
"session" "The current session"}
:returns inspector-returns}
"inspect-set-max-coll-size"
{:doc "Set the number of nested collection members to display before truncating."
{:doc "[DEPRECATED - use `inspect-refresh` instead] Set the number of nested collection members to display before truncating."
:requires {"max-coll-size" "New collection size."
"session" "The current session"}
:returns inspector-returns}
"inspect-set-max-nested-depth"
{:doc "Set the maximum nested levels to display before truncating."
{:doc "[DEPRECATED - use `inspect-refresh` instead] Set the maximum nested levels to display before truncating."
:requires {"max-nested-depth" "New nested depth."
"session" "The current session"}
:returns inspector-returns}
Expand Down Expand Up @@ -757,7 +762,7 @@ stack frame of the most recent exception. This op is deprecated, please use the
:optional (merge wrap-print-optional-arguments)
:returns (merge fail-fast-doc timing-info-return-doc)}
"test"
{:doc "[DEPRECATED - `use test-var-query` instead] Run tests in the specified namespace and return results. This accepts a set of `tests` to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests."
{:doc "[DEPRECATED - use `test-var-query` instead] Run tests in the specified namespace and return results. This accepts a set of `tests` to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests."
:optional wrap-print-optional-arguments
:returns (merge fail-fast-doc timing-info-return-doc)}
"test-all"
Expand All @@ -768,7 +773,7 @@ stack frame of the most recent exception. This op is deprecated, please use the
{:doc "Rerun all tests that did not pass when last run. Results are cached for exception retrieval and to enable re-running of failed/erring tests."
:optional wrap-print-optional-arguments}
"retest"
{:doc "[DEPRECATED - `use test-var-query` instead] Run all tests in the project. If `load?` is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests."
{:doc "[DEPRECATED - use `test-var-query` instead] Run all tests in the project. If `load?` is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests."
:optional wrap-print-optional-arguments
:returns (merge fail-fast-doc timing-info-return-doc)}}})

Expand Down

0 comments on commit ba445ca

Please sign in to comment.