Skip to content

Commit 0100adc

Browse files
authored
Document updated paredit ret behaviour (#3292)
1 parent 88ec63e commit 0100adc

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

doc/modules/ROOT/pages/additional_packages.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,21 @@ enable `paredit` in the REPL buffer as well:
122122
(add-hook 'cider-repl-mode-hook #'paredit-mode)
123123
----
124124

125+
==== Unsetting Paredit binding of RET key
126+
127+
In more recent versions of paredit, `RET` is bound to `paredit-RET`. This
128+
can cause unexpected behaviour in the repl when `paredit-mode` is enabled,
129+
e.g. it appears to hang after hitting `RET` instead of evaluating the last
130+
form.
131+
132+
You can disable the paredit behaviour by adding the following to your
133+
`init.el`:
134+
135+
[source,lisp]
136+
----
137+
(define-key paredit-mode-map (kbd "RET") nil)
138+
----
139+
125140
=== Smartparens
126141

127142
https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative

doc/modules/ROOT/pages/troubleshooting.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,3 +337,16 @@ $ guix package -i openjdk:jdk
337337
----
338338

339339
NOTE: On Windows and macOS the JDK source code is bundled with the JDK.
340+
341+
=== Hitting RET in the repl does not evaluate forms
342+
343+
In more recent versions of paredit, `RET` is bound to `paredit-RET`. This can cause unexpected
344+
behaviour in the repl when `paredit-mode` is enabled, e.g. it appears to hang after hitting
345+
`RET` instead of evaluating the last form.
346+
347+
You can disable the paredit behaviour by adding the following to your `init.el`:
348+
349+
[source,lisp]
350+
----
351+
(define-key paredit-mode-map (kbd "RET") nil)
352+
----

0 commit comments

Comments
 (0)