From 97690184afde83a7a0d4a28a688457208893b156 Mon Sep 17 00:00:00 2001
From: 45mg <45mg@no.mail>
Date: Fri, 29 Mar 2024 18:32:08 +0530
Subject: [PATCH] docs(corfu): `both` option for RET behavior

---
 modules/completion/corfu/README.org | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/modules/completion/corfu/README.org b/modules/completion/corfu/README.org
index 541510cb5..7618a3165 100644
--- a/modules/completion/corfu/README.org
+++ b/modules/completion/corfu/README.org
@@ -193,9 +193,13 @@ A few variables may be set to change behavior of this module:
 - [[var:corfu-preview-current]] ::
   Configures current candidate preview.
 - [[var:+corfu-want-ret-to-confirm]] ::
-  Enables commiting with [[RET]] when the popup is visible. Default is ~t~, may be set to
-  ~'minibuffer~ if you want to commit both the completion and the minibuffer when
-  active. When ~nil~, it is always passed-through.
+  Controls the behavior of [[kbd:][RET]] when the popup is visible - whether it confirms
+  the selected candidate, and whether [[kbd:][RET]] is passed through (ie. the normal
+  behavior of [[kbd:][RET]] is performed). The default value of ~t~ enables confirmation
+  and disables pass-through. Other variations are ~nil~ for pass-through and no
+  confirmation and ~both~ for confirmation followed by pass-through. Finally,
+  the value of ~minibuffer~ will both confirm and pass-through (like ~both~)
+  when in the minibuffer, and only confirm (like ~t~) otherwise.
 - [[var:+corfu-buffer-scanning-size-limit]]  ::
   Sets the maximum buffer size to be scanned by ~cape-dabbrev~. Defaults to 1 MB.
   Set this if you are having performance problems using the CAPF.