unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 28963@debbugs.gnu.org
Subject: bug#28963: 24.5; doc string of `dired-find-alternate-file'
Date: Mon, 23 Oct 2017 19:07:02 -0700 (PDT)	[thread overview]
Message-ID: <a1d5ae6c-832b-44d9-b17e-c346828edcc6@default> (raw)

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'





             reply	other threads:[~2017-10-24  2:07 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-24  2:07 Drew Adams [this message]
2017-10-27 14:59 ` bug#28963: 24.5; doc string of `dired-find-alternate-file' 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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=a1d5ae6c-832b-44d9-b17e-c346828edcc6@default \
    --to=drew.adams@oracle.com \
    --cc=28963@debbugs.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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).