branch: elpa/cider
commit 53f0f6edc7ec5830395a546b78b0f34dfb8272c3
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Minor documentation tweaks
---
cider-connection.el | 2 +-
doc/modules/ROOT/pages/additional_packages.adoc | 23 ++++++++++++----------
doc/modules/ROOT/pages/repl/configuration.adoc | 2 +-
doc/modules/ROOT/pages/troubleshooting.adoc | 4 ++--
.../ROOT/pages/usage/managing_connections.adoc | 19 ++++++++++++------
5 files changed, 30 insertions(+), 20 deletions(-)
diff --git a/cider-connection.el b/cider-connection.el
index 1983c75f85..d223166ca7 100644
--- a/cider-connection.el
+++ b/cider-connection.el
@@ -69,7 +69,7 @@ Useful for switching between alternative minor modes like
`inf-clojure-mode'."
:package-version '(cider . "0.9.0"))
(defcustom cider-merge-sessions nil
- "Controls session combination behaviour.
+ "Controls session combination behavior.
Symbol `host' combines all sessions of a project associated with the same host.
Symbol `project' combines all sessions of a project.
diff --git a/doc/modules/ROOT/pages/additional_packages.adoc
b/doc/modules/ROOT/pages/additional_packages.adoc
index f074a4a676..a4dcc2297d 100644
--- a/doc/modules/ROOT/pages/additional_packages.adoc
+++ b/doc/modules/ROOT/pages/additional_packages.adoc
@@ -133,13 +133,13 @@ enable `paredit` in the REPL buffer as well:
(add-hook 'cider-repl-mode-hook #'paredit-mode)
----
-==== Unsetting Paredit binding of RET key
+==== Unsetting the Paredit binding of the RET key
In recent versions of Paredit (25+), `RET` is bound to `paredit-RET`. This can
cause unexpected
-behaviour in the repl when `paredit-mode` is enabled, e.g. it appears to hang
after hitting
+behavior in the REPL when `paredit-mode` is enabled, e.g. it appears to hang
after hitting
`RET` instead of evaluating the last form.
-You can disable this Paredit behaviour by adding the following to your
`init.el`:
+You can disable this Paredit behavior by adding the following to your
`init.el`:
[source,lisp]
----
@@ -148,20 +148,24 @@ You can disable this Paredit behaviour by adding the
following to your `init.el`
=== paren-face
-https://github.com/tarsius/paren-face[paren-face] defines a face named
`parenthesis` used just for parentheses. The originally intended purpose of
this face is to make parentheses less visible in Lisp code by dimming them.
+https://github.com/tarsius/paren-face[paren-face] defines a face named
+`parenthesis` used just for parentheses. The originally intended purpose of
this
+face is to make parentheses less visible in Lisp code by dimming them.
In the author's words:
-> We lispers probably don’t need to be constantly made aware of the existence
of the parentheses. Dimming them might be even more useful for people new to
lisp who have not yet learned to subconsciously blend out the parentheses.
+> We lispers probably don’t need to be constantly made aware of the existence
of
+> the parentheses. Dimming them might be even more useful for people new to
lisp
+> who have not yet learned to subconsciously blend out the parentheses.
TIP: the following customization expands paren-face to dim even more
delimiters from the Clojure language: `(setq paren-face-regexp "\\([(
]\\.-\\|[( ]\\.+\\|[][(){}#/]\\)")`.
=== Smartparens
-https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative
- to paredit. Many Clojure hackers have adopted it recently and you might want
- to give it a try as well. To enable `smartparens` in the REPL buffer use the
- following code:
+https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative
to
+paredit. Many Clojure hackers have adopted it recently and you might want to
+give it a try as well. To enable `smartparens` in the REPL buffer use the
+following code:
[source,lisp]
----
@@ -214,4 +218,3 @@ forms directly in the REPL.
It's basically a simple alternative of CIDER, which provides a subset of
CIDER's
functionality.
-
diff --git a/doc/modules/ROOT/pages/repl/configuration.adoc
b/doc/modules/ROOT/pages/repl/configuration.adoc
index 39458d4749..4a8f7c3a53 100644
--- a/doc/modules/ROOT/pages/repl/configuration.adoc
+++ b/doc/modules/ROOT/pages/repl/configuration.adoc
@@ -131,7 +131,7 @@ be displayed you'll need to add the following to your
config:
(setq cider-repl-display-output-before-window-boundaries t)
----
-NOTE: This behaviour was changed in CIDER 1.7, as the auto-scrolling of output
+NOTE: This behavior was changed in CIDER 1.7, as the auto-scrolling of output
before the REPL prompt is rarely needed, but it's current implementation is
very
slow.
diff --git a/doc/modules/ROOT/pages/troubleshooting.adoc
b/doc/modules/ROOT/pages/troubleshooting.adoc
index 152319206e..9f6e523c3d 100644
--- a/doc/modules/ROOT/pages/troubleshooting.adoc
+++ b/doc/modules/ROOT/pages/troubleshooting.adoc
@@ -329,10 +329,10 @@ NOTE: On Windows and macOS the JDK source code is bundled
with the JDK.
Are you a Paredit user? Have you enabled for the REPL buffers?
In recent versions of Paredit (25+), `RET` is bound to `paredit-RET`. This can
cause unexpected
-behaviour in the repl when `paredit-mode` is enabled, e.g. it appears to hang
after hitting
+behavior in the repl when `paredit-mode` is enabled, e.g. it appears to hang
after hitting
`RET` instead of evaluating the last form.
-You can disable this Paredit behaviour by adding the following to your
`init.el`:
+You can disable this Paredit behavior by adding the following to your
`init.el`:
[source,lisp]
----
diff --git a/doc/modules/ROOT/pages/usage/managing_connections.adoc
b/doc/modules/ROOT/pages/usage/managing_connections.adoc
index 73b6907a53..406791d405 100644
--- a/doc/modules/ROOT/pages/usage/managing_connections.adoc
+++ b/doc/modules/ROOT/pages/usage/managing_connections.adoc
@@ -195,15 +195,22 @@ names with `nrepl-repl-buffer-name-template`. See also
== Reusing dead REPLs
-Under normal circumstances, CIDER automatically kills the REPL buffers and
cleans up after itself when ending a session.
-However, when a session is terminated unexpectedly, e.g. when it crashes or is
disconnected from an external server process, the REPL buffer is left without
an active connection and outputs a log:
+Under normal circumstances, CIDER automatically kills the REPL buffers and
+cleans up after itself when ending a session. However, when a session is
+terminated unexpectedly, e.g. when it crashes or is disconnected from an
+external server process, the REPL buffer is left without an active connection
+and outputs a log:
[source]
----
*** Closed on < date/time > ***
----
-Upon starting a new connection, CIDER can detect these "dead REPLs" and offer
to reuse the buffer for the new connection.
-By default, it prompts for confirmation whenever a dead REPL buffer is
available for reuse, but you can customize this behaviour via the variable
`cider-reuse-dead-repls`.
-Setting it to `auto` reuses a dead REPL buffer automatically, and only
displays a prompt when there are multiple options to choose from.
-To suppress the prompt entirely, set it to `nil` to always start a new REPL
buffer, or `any` to reuse the most relevant dead REPL.
+Upon starting a new connection, CIDER can detect these "dead REPLs" and offer
to
+reuse the buffer for the new connection. By default, it prompts for
+confirmation whenever a dead REPL buffer is available for reuse, but you can
+customize this behavior via the variable `cider-reuse-dead-repls`. Setting it
+to `auto` reuses a dead REPL buffer automatically, and only displays a prompt
+when there are multiple options to choose from. To suppress the prompt
+entirely, set it to `nil` to always start a new REPL buffer, or `any` to reuse
+the most relevant dead REPL.
