GNU bug report logs - #11201
24.0.93; ido.el: Documentation for C-j in ido-find-file and ido-switch-buffer

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 11201 in the body.
You can then email your comments to 11201 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: David Röthlisberger <david <at> rothlis.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.0.93;
	ido.el: Documentation for C-j in ido-find-file and ido-switch-buffer
Date: Sun, 8 Apr 2012 13:33:22 +0100

The documentation string for 'ido-find-file' has the following description for 'C-j':

> Select the current prompt as the buffer or file.
> If no buffer or file is found, prompt for a new one.

I found this rather confusing. The word "prompt" isn't used anywhere else in the documentation string to mean what the user has typed; whereas "string", "input string" and "substring" are used several times. 'ido-switch-buffer' has the same problem.

When I was a new user of 'ido', the most annoying thing was not being able to visit a new, non-existent file or buffer, because the name I wanted would match part of another file/buffer name. I reading the documentation several times but still didn't realize that's what C-j does.

The second sentence ("If no buffer or file is found, prompt for a new one") seems to be flat-out false. I have not been able to reproduce this behaviour under ido-find-file or ido-switch-buffer, with empty input or otherwise.

Patch below.

Kind regards,
Dave.


From: David Rothlisberger <david <at> rothlis.net>
Date: Sun, 8 Apr 2012 12:56:56 +0100
Subject: [PATCH] * ido.el: Documentation for C-j in ido-find-file and
 ido-switch-buffer.

---
 lisp/ido.el |    6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/lisp/ido.el b/lisp/ido.el
index fe94c7f..4f1bf04 100644
--- a/lisp/ido.el
+++ b/lisp/ido.el
@@ -4046,8 +4046,7 @@ (defun ido-switch-buffer ()
 RET Select the buffer at the front of the list of matches.  If the
 list is empty, possibly prompt to create new buffer.
 
-\\[ido-select-text] Select the current prompt as the buffer.
-If no buffer is found, prompt for a new one.
+\\[ido-select-text] Use the current input string verbatim.
 
 \\[ido-next-match] Put the first element at the end of the list.
 \\[ido-prev-match] Put the last element at the start of the list.
@@ -4133,8 +4132,7 @@ (defun ido-find-file ()
 RET Select the file at the front of the list of matches.  If the
 list is empty, possibly prompt to create new file.
 
-\\[ido-select-text] Select the current prompt as the buffer or file.
-If no buffer or file is found, prompt for a new one.
+\\[ido-select-text] Use the current input string verbatim.
 
 \\[ido-next-match] Put the first element at the end of the list.
 \\[ido-prev-match] Put the last element at the start of the list.
-- 
1.7.9.2

Message #8 received at 11201 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: "Kim F. Storm" <storm <at> cua.dk>
Cc: 11201 <at> debbugs.gnu.org
Subject: Bug report about IDO docstring for C-j
Date: Tue, 19 Jun 2012 14:12:22 -0400

Hi Kim,

Hope you're having fun and still using Emacs.

Could you take a look at this bug report
http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11201.  Replacing "prompt"
with "input string" should address the main issue, but I'm not
completely sure about the behavior when no file/buffer is found, whether
it's a doc bug or a code bug.


        Stefan

Message #11 received at 11201 <at> debbugs.gnu.org (full text, mbox):

From: Kim Storm <storm <at> cua.dk>
To: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
Cc: 11201 <at> debbugs.gnu.org
Subject: Re: Bug report about IDO docstring for C-j
Date: Tue, 19 Jun 2012 20:47:15 +0200

Hi Stefan

The changes looks good. Thanks.

The prompting for a new file/buffer was removed a long time ago.

Kim

Message #16 received at 11201-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: David Röthlisberger <david <at> rothlis.net>
Cc: 11201-done <at> debbugs.gnu.org, Kim Storm <storm <at> cua.dk>
Subject: Re: bug#11201: 24.0.93;
	ido.el: Documentation for C-j in ido-find-file and ido-switch-buffer
Date: Wed, 20 Jun 2012 11:52:34 -0400

> I found this rather confusing. The word "prompt" isn't used anywhere else in
> the documentation string to mean what the user has typed; whereas "string",
> "input string" and "substring" are used several times. 'ido-switch-buffer'
> has the same problem.

Thanks, I installed your patch,


        Stefan

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.