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

Previous Next

Package: emacs;

Reported by: Clément Pit--Claudel <clement.pitclaudel <at> live.com>

Date: Sun, 12 Nov 2017 23:13:01 UTC

Severity: minor

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#29278: closed (Incorrect documentation of ido-find-alternate-file)
Date: Sat, 18 Nov 2017 11:17:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sat, 18 Nov 2017 13:16:08 +0200
with message-id <83shdbg7lz.fsf <at> gnu.org>
and subject line Re: bug#29278: Incorrect documentation of ido-find-alternate-file
has caused the debbugs.gnu.org bug report #29278,
regarding Incorrect documentation of ido-find-alternate-file
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
29278: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=29278
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
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 3 (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 part 5 (message/rfc822, inline)]
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.


This bug report was last modified 7 years and 182 days ago.

Previous Next


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