branch: elpa/cider
commit 0100adccf5ca2c1f30eef5ce808e498cc50732c1
Author: Ron Toland <c...@ron.toland.io>
Commit: GitHub <nore...@github.com>
Document updated paredit ret behaviour (#3292)
---
doc/modules/ROOT/pages/additional_packages.adoc | 15 +++++++++++++++
doc/modules/ROOT/pages/troubleshooting.adoc | 13 +++++++++++++
2 files changed, 28 insertions(+)
diff --git a/doc/modules/ROOT/pages/additional_packages.adoc
b/doc/modules/ROOT/pages/additional_packages.adoc
index 2fd182cfc3..c460793f6a 100644
--- a/doc/modules/ROOT/pages/additional_packages.adoc
+++ b/doc/modules/ROOT/pages/additional_packages.adoc
@@ -122,6 +122,21 @@ enable `paredit` in the REPL buffer as well:
(add-hook 'cider-repl-mode-hook #'paredit-mode)
----
+==== Unsetting Paredit binding of RET key
+
+In more recent versions of paredit, `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 `RET` instead of evaluating the last
+form.
+
+You can disable the paredit behaviour by adding the following to your
+`init.el`:
+
+[source,lisp]
+----
+(define-key paredit-mode-map (kbd "RET") nil)
+----
+
=== Smartparens
https://github.com/Fuco1/smartparens[smartparens] is an excellent alternative
diff --git a/doc/modules/ROOT/pages/troubleshooting.adoc
b/doc/modules/ROOT/pages/troubleshooting.adoc
index 34419edf24..0f3b812a0d 100644
--- a/doc/modules/ROOT/pages/troubleshooting.adoc
+++ b/doc/modules/ROOT/pages/troubleshooting.adoc
@@ -337,3 +337,16 @@ $ guix package -i openjdk:jdk
----
NOTE: On Windows and macOS the JDK source code is bundled with the JDK.
+
+=== Hitting RET in the repl does not evaluate forms
+
+In more recent versions of paredit, `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
+`RET` instead of evaluating the last form.
+
+You can disable the paredit behaviour by adding the following to your
`init.el`:
+
+[source,lisp]
+----
+(define-key paredit-mode-map (kbd "RET") nil)
+----
