Skip to content

Commit 53f0f6e

Browse files
committed
Minor documentation tweaks
1 parent 9b002c0 commit 53f0f6e

File tree

5 files changed

+30
-20
lines changed

5 files changed

+30
-20
lines changed

cider-connection.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Useful for switching between alternative minor modes like `inf-clojure-mode'."
6969
:package-version '(cider . "0.9.0"))
7070

7171
(defcustom cider-merge-sessions nil
72-
"Controls session combination behaviour.
72+
"Controls session combination behavior.
7373
7474
Symbol `host' combines all sessions of a project associated with the same host.
7575
Symbol `project' combines all sessions of a project.

doc/modules/ROOT/pages/additional_packages.adoc

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,13 @@ enable `paredit` in the REPL buffer as well:
133133
(add-hook 'cider-repl-mode-hook #'paredit-mode)
134134
----
135135

136-
==== Unsetting Paredit binding of RET key
136+
==== Unsetting the Paredit binding of the RET key
137137

138138
In recent versions of Paredit (25+), `RET` is bound to `paredit-RET`. This can cause unexpected
139-
behaviour in the repl when `paredit-mode` is enabled, e.g. it appears to hang after hitting
139+
behavior in the REPL when `paredit-mode` is enabled, e.g. it appears to hang after hitting
140140
`RET` instead of evaluating the last form.
141141

142-
You can disable this Paredit behaviour by adding the following to your `init.el`:
142+
You can disable this Paredit behavior by adding the following to your `init.el`:
143143

144144
[source,lisp]
145145
----
@@ -148,20 +148,24 @@ You can disable this Paredit behaviour by adding the following to your `init.el`
148148

149149
=== paren-face
150150

151-
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.
151+
https://github.com/tarsius/paren-face[paren-face] defines a face named
152+
`parenthesis` used just for parentheses. The originally intended purpose of this
153+
face is to make parentheses less visible in Lisp code by dimming them.
152154

153155
In the author's words:
154156

155-
> 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.
157+
> We lispers probably don’t need to be constantly made aware of the existence of
158+
> the parentheses. Dimming them might be even more useful for people new to lisp
159+
> who have not yet learned to subconsciously blend out the parentheses.
156160

157161
TIP: the following customization expands paren-face to dim even more delimiters from the Clojure language: `(setq paren-face-regexp "\\([( ]\\.-\\|[( ]\\.+\\|[][(){}#/]\\)")`.
158162

159163
=== Smartparens
160164

161-
https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative
162-
to paredit. Many Clojure hackers have adopted it recently and you might want
163-
to give it a try as well. To enable `smartparens` in the REPL buffer use the
164-
following code:
165+
https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative to
166+
paredit. Many Clojure hackers have adopted it recently and you might want to
167+
give it a try as well. To enable `smartparens` in the REPL buffer use the
168+
following code:
165169

166170
[source,lisp]
167171
----
@@ -214,4 +218,3 @@ forms directly in the REPL.
214218

215219
It's basically a simple alternative of CIDER, which provides a subset of CIDER's
216220
functionality.
217-

doc/modules/ROOT/pages/repl/configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ be displayed you'll need to add the following to your config:
131131
(setq cider-repl-display-output-before-window-boundaries t)
132132
----
133133

134-
NOTE: This behaviour was changed in CIDER 1.7, as the auto-scrolling of output
134+
NOTE: This behavior was changed in CIDER 1.7, as the auto-scrolling of output
135135
before the REPL prompt is rarely needed, but it's current implementation is very
136136
slow.
137137

doc/modules/ROOT/pages/troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,10 +329,10 @@ NOTE: On Windows and macOS the JDK source code is bundled with the JDK.
329329
Are you a Paredit user? Have you enabled for the REPL buffers?
330330

331331
In recent versions of Paredit (25+), `RET` is bound to `paredit-RET`. This can cause unexpected
332-
behaviour in the repl when `paredit-mode` is enabled, e.g. it appears to hang after hitting
332+
behavior in the repl when `paredit-mode` is enabled, e.g. it appears to hang after hitting
333333
`RET` instead of evaluating the last form.
334334

335-
You can disable this Paredit behaviour by adding the following to your `init.el`:
335+
You can disable this Paredit behavior by adding the following to your `init.el`:
336336

337337
[source,lisp]
338338
----

doc/modules/ROOT/pages/usage/managing_connections.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,15 +195,22 @@ names with `nrepl-repl-buffer-name-template`. See also
195195

196196
== Reusing dead REPLs
197197

198-
Under normal circumstances, CIDER automatically kills the REPL buffers and cleans up after itself when ending a session.
199-
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:
198+
Under normal circumstances, CIDER automatically kills the REPL buffers and
199+
cleans up after itself when ending a session. However, when a session is
200+
terminated unexpectedly, e.g. when it crashes or is disconnected from an
201+
external server process, the REPL buffer is left without an active connection
202+
and outputs a log:
200203

201204
[source]
202205
----
203206
*** Closed on < date/time > ***
204207
----
205208

206-
Upon starting a new connection, CIDER can detect these "dead REPLs" and offer to reuse the buffer for the new connection.
207-
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`.
208-
Setting it to `auto` reuses a dead REPL buffer automatically, and only displays a prompt when there are multiple options to choose from.
209-
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.
209+
Upon starting a new connection, CIDER can detect these "dead REPLs" and offer to
210+
reuse the buffer for the new connection. By default, it prompts for
211+
confirmation whenever a dead REPL buffer is available for reuse, but you can
212+
customize this behavior via the variable `cider-reuse-dead-repls`. Setting it
213+
to `auto` reuses a dead REPL buffer automatically, and only displays a prompt
214+
when there are multiple options to choose from. To suppress the prompt
215+
entirely, set it to `nil` to always start a new REPL buffer, or `any` to reuse
216+
the most relevant dead REPL.

0 commit comments

Comments
 (0)