all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#28963: 24.5; doc string of `dired-find-alternate-file'
@ 2017-10-24  2:07 Drew Adams
  2017-10-27 14:59 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2017-10-24  2:07 UTC (permalink / raw)
  To: 28963

This doc string needs improvement:

  In Dired, visit this file or directory instead of the Dired buffer.

The real meaning depends on what one understands by "instead of the
Dired buffer".  Many users will likely (mis)understand only that the
file or directory is visited in place of the current Dired buffer.
They won't understand that the current buffer will be killed.

If the idea is to keep the doc string short, it would be far more
helpful to say that it uses `find-alternate-file', because that command
has much better documentation.  In particular, it says explicitly: "kill
previous buffer".

It shouldn't be _necessary_ to keep the doc string to a minimum and only
reference `find-alternate-file'.  But if there is no desire to provide
the kind of info we provide for `find-alternate-file' then it would be
fine to just reference that function's doc.



In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'





^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#28963: 24.5; doc string of `dired-find-alternate-file'
  2017-10-24  2:07 bug#28963: 24.5; doc string of `dired-find-alternate-file' Drew Adams
@ 2017-10-27 14:59 ` Eli Zaretskii
  0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2017-10-27 14:59 UTC (permalink / raw)
  To: Drew Adams; +Cc: 28963-done

> Date: Mon, 23 Oct 2017 19:07:02 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> 
> This doc string needs improvement:
> 
>   In Dired, visit this file or directory instead of the Dired buffer.
> 
> The real meaning depends on what one understands by "instead of the
> Dired buffer".  Many users will likely (mis)understand only that the
> file or directory is visited in place of the current Dired buffer.
> They won't understand that the current buffer will be killed.
> 
> If the idea is to keep the doc string short, it would be far more
> helpful to say that it uses `find-alternate-file', because that command
> has much better documentation.  In particular, it says explicitly: "kill
> previous buffer".

I did both, thanks.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-10-27 14:59 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-10-24  2:07 bug#28963: 24.5; doc string of `dired-find-alternate-file' Drew Adams
2017-10-27 14:59 ` Eli Zaretskii

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.