unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: doc string of insert-default-directory is unclear
Date: Sat, 2 Feb 2008 17:31:49 -0800	[thread overview]
Message-ID: <001301c86604$8c9e5c30$2c49908d@us.oracle.com> (raw)

Don't ask me why it's unclear to me, if it's clear to you. In that
case, just take it that at least one user finds this unclear.
 
In previous releases, the doc string said only what its first line
says. The rest was presumably added in Emacs 22 to clarify the meaning
and use. But I find it totally confusing.
 
In particular, the second sentence is not clear, I think:
 
 "If the initial minibuffer contents are non-empty,
  you can usually request a default filename by typing
  RETURN without editing."
 
Please consider rephrasing the entire doc string. A good starting
point could be to explain the significance of the initial contents
being non-empty. The doc string should give you an idea when you might
want to bind this to nil or non-nil. That is not the case now, IMO.
 

In GNU Emacs 22.1.1 (i386-mingw-nt5.1.2600)
 of 2007-06-02 on RELEASE
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --cflags -Ic:/gnuwin32/include'
 





             reply	other threads:[~2008-02-03  1:31 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-03  1:31 Drew Adams [this message]
2008-02-09 13:24 ` doc string of insert-default-directory is unclear Eli Zaretskii
2008-02-09 15:59   ` Drew Adams
2008-02-09 16:35     ` Eli Zaretskii
2008-02-09 19:17       ` Drew Adams

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='001301c86604$8c9e5c30$2c49908d@us.oracle.com' \
    --to=drew.adams@oracle.com \
    --cc=bug-gnu-emacs@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).