all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: sbaugh@catern.com
To: Eli Zaretskii <eliz@gnu.org>
Cc: 64425@debbugs.gnu.org
Subject: bug#64425: [PATCH] Mention minibuffer-next-completion in completion-help
Date: Sun, 02 Jul 2023 19:14:06 +0000 (UTC)	[thread overview]
Message-ID: <873526rurm.fsf@catern.com> (raw)
In-Reply-To: <837crinsho.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 02 Jul 2023 20:16:51 +0300")

[-- Attachment #1: Type: text/plain, Size: 2781 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: sbaugh@catern.com
>> Date: Sun, 02 Jul 2023 16:31:21 +0000 (UTC)
>> 
>> * lisp/simple.el (completion-list-mode-map): Bind
>> minibuffer-{next,previous,choose}-completion.
>> (completion-setup-function): Mention bindings for
>> minibuffer-{next,previous,choose}-completion.
>> ---
>>  lisp/simple.el | 7 +++++--
>>  1 file changed, 5 insertions(+), 2 deletions(-)
>> 
>> diff --git a/lisp/simple.el b/lisp/simple.el
>> index 406f1008df3..59e1311eb2b 100644
>> --- a/lisp/simple.el
>> +++ b/lisp/simple.el
>> @@ -9697,6 +9697,9 @@ completion-list-mode-map
>>      (define-key map [right] 'next-completion)
>>      (define-key map [?\t] 'next-completion)
>>      (define-key map [backtab] 'previous-completion)
>> +    (define-key map (kbd "M-<up>") 'minibuffer-previous-completion)
>> +    (define-key map (kbd "M-<down>") 'minibuffer-next-completion)
>> +    (define-key map (kbd "M-RET") 'minibuffer-choose-completion)
>>      (define-key map "z" 'kill-current-buffer)
>>      (define-key map "n" 'next-completion)
>>      (define-key map "p" 'previous-completion)
>> @@ -10093,8 +10096,8 @@ completion-setup-function
>>  	(goto-char (point-min))
>>  	(if (display-mouse-p)
>>  	    (insert "Click on a completion to select it.\n"))
>> -	(insert (substitute-command-keys
>> -		 "In this buffer, type \\[choose-completion] to \
>> +        (insert (substitute-command-keys
>> +		 "Type \\[minibuffer-next-completion] and \\[minibuffer-previous-completion] to change completion, and \\[minibuffer-choose-completion] to \
>>  select the completion near point.\n\n"))))))
>
> Isn't this text too long for a single screen line?  If so, it will
> cause an annoying "jumping" of the mode line.

Good point, how about this wording:

diff --git a/lisp/simple.el b/lisp/simple.el
index 406f1008df3..26944f1f72d 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -10091,11 +10094,13 @@ completion-setup-function
       ;; Maybe insert help string.
       (when completion-show-help
 	(goto-char (point-min))
-	(if (display-mouse-p)
-	    (insert "Click on a completion to select it.\n"))
-	(insert (substitute-command-keys
-		 "In this buffer, type \\[choose-completion] to \
-select the completion near point.\n\n"))))))
+        (insert (substitute-command-keys
+	         (if (display-mouse-p)
+	             "Click or type \\[minibuffer-choose-completion] on a completion to select it.\n"
+                   "Type \\[minibuffer-choose-completion] on a completion to select it.\n")))
+        (insert (substitute-command-keys
+		 "Type \\[minibuffer-next-completion] or \\[minibuffer-previous-completion] \
+to move point between completions.\n\n"))))))
 
 (add-hook 'completion-setup-hook #'completion-setup-function)
 
Associated patch:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Mention-minibuffer-next-completion-in-completion-hel.patch --]
[-- Type: text/x-patch, Size: 2551 bytes --]

From d551dd05ce14fbc950b98965e456bdac253650d0 Mon Sep 17 00:00:00 2001
From: Spencer Baugh <sbaugh@catern.com>
Date: Sun, 2 Jul 2023 12:30:00 -0400
Subject: [PATCH] Mention minibuffer-next-completion in completion-help

Now that it's not necessary to switch to the *Completions* buffer to
switch between and choose completions, we should make that clear in
the help text.  Let's also make the bindings uniform both in and
outside the *Completions* buffer so users don't have to think about
the difference.

In working with new users, they've assumed that since the help text in
*Completions* says "Click on a completion to select it", that that's
the only way to select a completion.  This text should help clarify
that.

* lisp/simple.el (completion-list-mode-map): Bind
minibuffer-{next,previous,choose}-completion.
(completion-setup-function): Mention bindings for
minibuffer-{next,previous,choose}-completion. (Bug#64425)
---
 lisp/simple.el | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/lisp/simple.el b/lisp/simple.el
index 406f1008df3..26944f1f72d 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -9697,6 +9697,9 @@ completion-list-mode-map
     (define-key map [right] 'next-completion)
     (define-key map [?\t] 'next-completion)
     (define-key map [backtab] 'previous-completion)
+    (define-key map (kbd "M-<up>") 'minibuffer-previous-completion)
+    (define-key map (kbd "M-<down>") 'minibuffer-next-completion)
+    (define-key map (kbd "M-RET") 'minibuffer-choose-completion)
     (define-key map "z" 'kill-current-buffer)
     (define-key map "n" 'next-completion)
     (define-key map "p" 'previous-completion)
@@ -10091,11 +10094,13 @@ completion-setup-function
       ;; Maybe insert help string.
       (when completion-show-help
 	(goto-char (point-min))
-	(if (display-mouse-p)
-	    (insert "Click on a completion to select it.\n"))
-	(insert (substitute-command-keys
-		 "In this buffer, type \\[choose-completion] to \
-select the completion near point.\n\n"))))))
+        (insert (substitute-command-keys
+	         (if (display-mouse-p)
+	             "Click or type \\[minibuffer-choose-completion] on a completion to select it.\n"
+                   "Type \\[minibuffer-choose-completion] on a completion to select it.\n")))
+        (insert (substitute-command-keys
+		 "Type \\[minibuffer-next-completion] or \\[minibuffer-previous-completion] \
+to move point between completions.\n\n"))))))
 
 (add-hook 'completion-setup-hook #'completion-setup-function)
 
-- 
2.41.0


[-- Attachment #3: Type: text/plain, Size: 186 bytes --]


> Also, what about updating the documentation?

All the other relevant documentation that I know about has already been
updated to mention minibuffer-{next,previous,choose}-completion.

  reply	other threads:[~2023-07-02 19:14 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-02 16:31 bug#64425: [PATCH] Mention minibuffer-next-completion in completion-help sbaugh
2023-07-02 17:16 ` Eli Zaretskii
2023-07-02 19:14   ` sbaugh [this message]
2023-07-03 11:21     ` Eli Zaretskii
2023-07-03 12:53       ` Spencer Baugh
2023-07-03 13:16         ` Eli Zaretskii
     [not found] <4beb74b6-6bbc-4e0f-9b95-f95b7edf79b9@email.android.com>
2023-07-03 13:28 ` Eli Zaretskii
2023-07-03 13:31   ` Spencer Baugh
2023-07-03 13:43     ` Eli Zaretskii
2023-07-03 14:00       ` Spencer Baugh
2023-07-06  7:43         ` Eli Zaretskii
2023-07-06 13:00           ` Spencer Baugh
2023-07-08  9:53             ` Eli Zaretskii
     [not found] <e7933bfa-c6e1-4586-b9f0-8bc3555329ef@email.android.com>
2023-07-08 13:51 ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=873526rurm.fsf@catern.com \
    --to=sbaugh@catern.com \
    --cc=64425@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.