emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/mct d55400b6b1 13/23: Improve mct-tcm documentation


From: ELPA Syncer
Subject: [elpa] externals/mct d55400b6b1 13/23: Improve mct-tcm documentation
Date: Fri, 25 Feb 2022 07:57:38 -0500 (EST)

branch: externals/mct
commit d55400b6b19bcf42bc1c7c161b57e44c448dd873
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Improve mct-tcm documentation
    
    For a discussion, see issue 25: 
<https://gitlab.com/protesilaos/mct/-/issues/25>.
---
 mct-tcm.el | 37 +++++++++++++++++++++++++------------
 1 file changed, 25 insertions(+), 12 deletions(-)

diff --git a/mct-tcm.el b/mct-tcm.el
index 757126ec7c..4f6915420d 100644
--- a/mct-tcm.el
+++ b/mct-tcm.el
@@ -24,12 +24,18 @@
 
 ;;; Commentary:
 ;;
-;; An extension to MCT that intercepts single character keys in the
-;; Completions' buffer and sends them as input in the minibuffer.  In
-;; practice, this means that the user can start typing something in the
-;; minibuffer, switch to the Completions to select something, realise
-;; that they need to narrow further, type some further input which takes
-;; them back to the minibuffer.
+;; MCT extension which Treats the Completions as the Minibuffer.  It
+;; intercepts any single character input (without Control or Alt
+;; modifiers) in the Completions' buffer and passes it to the minibuffer
+;; as input.  This practically means that the user can (i) narrow the
+;; list of candidates from the minibuffer, (ii) switch to the
+;; Completions in anticipation of selecting a candidate, (iii) change
+;; their mind and opt to narrow further, (iv) type something to bring
+;; focus back to the minibuffer while narrowing to the given input.
+;;
+;; When the `mct-tcm-mode' is enabled and the above sequence takes
+;; place, the current session is treated as if it belongs to the
+;; `mct-completion-passlist' (read its doc string).
 
 ;;; Code:
 
@@ -40,12 +46,19 @@
 ;; FIXME 2022-02-22: Silence message when key binding is undefined.
 ;;;###autoload
 (define-minor-mode mct-tcm-mode
-  "MCT extension to narrow through the Completions.
-It intercepts any single character input (without modifiers) in
-the Completions' buffer and passes it to the minibuffer as input.
-This practically means that the user can switch to the
-Completions and then type something to bring focus to the
-minibuffer while narrowing to the given input."
+  "MCT extension which Treats the Completions as the Minibuffer.
+It intercepts any single character input (without Control or Alt
+modifiers) in the Completions' buffer and passes it to the
+minibuffer as input.  This practically means that the user
+can (i) narrow the list of candidates from the minibuffer, (ii)
+switch to the Completions in anticipation of selecting a
+candidate, (iii) change their mind and opt to narrow
+further, (iv) type something to bring focus back to the
+minibuffer while narrowing to the given input.
+
+When this mode is enabled and the above sequence takes place, the
+current session is treated as if it belongs to the
+`mct-completion-passlist' (read its doc string)."
   :global t
   :group 'mct
   (if mct-tcm-mode



reply via email to

[Prev in Thread] Current Thread [Next in Thread]