GNU bug report logs - #29278
Incorrect documentation of ido-find-alternate-file

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 29278 in the body.
You can then email your comments to 29278 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: Clément Pit--Claudel <clement.pitclaudel <at> live.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Incorrect documentation of ido-find-alternate-file
Date: Sun, 12 Nov 2017 18:12:18 -0500

[Message part 1 (text/plain, inline)]

The docstring of ido-find-alternate-file is wrong:

;;;###autoload
(defun ido-find-file-other-window ()
  "Switch to another file and show it in another window.
The file name is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
  (interactive)
  (ido-file-internal 'other-window 'find-file-other-window))

;;;###autoload
(defun ido-find-alternate-file ()
  "Switch to another file and show it in another window.
The file name is selected interactively by typing a substring.
For details of keybindings, see `ido-find-file'."
  (interactive)
  (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))

The first line of ido-find-alternate-file could be changed to "Find file FILENAME, select its buffer, kill previous buffer." to fix this.

Cheers,
Clément.

[signature.asc (application/pgp-signature, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Clément Pit--Claudel <clement.pitclaudel <at> live.com>
Cc: 29278-done <at> debbugs.gnu.org
Subject: Re: bug#29278: Incorrect documentation of ido-find-alternate-file
Date: Sat, 18 Nov 2017 13:16:08 +0200

> From: Clément Pit--Claudel <clement.pitclaudel <at> live.com>
> Date: Sun, 12 Nov 2017 18:12:18 -0500
> 
> The docstring of ido-find-alternate-file is wrong:
> 
> ;;;###autoload
> (defun ido-find-file-other-window ()
>   "Switch to another file and show it in another window.
> The file name is selected interactively by typing a substring.
> For details of keybindings, see `ido-find-file'."
>   (interactive)
>   (ido-file-internal 'other-window 'find-file-other-window))
> 
> ;;;###autoload
> (defun ido-find-alternate-file ()
>   "Switch to another file and show it in another window.
> The file name is selected interactively by typing a substring.
> For details of keybindings, see `ido-find-file'."
>   (interactive)
>   (ido-file-internal 'alt-file 'find-alternate-file nil "Find alternate file: "))
> 
> The first line of ido-find-alternate-file could be changed to "Find file FILENAME, select its buffer, kill previous buffer." to fix this.

There's no FILENAME in the argument list of ido-find-alternate-file,
so I've installed a slightly different change.

Thanks.

Previous Next

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