emacs-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[debbugs-tracker] bug#33339: closed (26; doc string of `write-file`)


From: GNU bug Tracking System
Subject: [debbugs-tracker] bug#33339: closed (26; doc string of `write-file`)
Date: Sun, 11 Nov 2018 16:22:02 +0000

Your message dated Sun, 11 Nov 2018 18:20:36 +0200
with message-id <address@hidden>
and subject line Re: bug#33339: 26; doc string of `write-file`
has caused the debbugs.gnu.org bug report #33339,
regarding 26; doc string of `write-file`
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
33339: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=33339
GNU Bug Tracking System
Contact address@hidden with problems
--- Begin Message --- Subject: 26; doc string of `write-file` Date: Sat, 10 Nov 2018 14:42:16 -0800 (PST)
 "If you specify just a directory name as FILENAME, that means to use
  the default file name but in that directory.  You can also yank
  the default file name into the minibuffer to edit it, using M-n."

"The default file name" is undefined.  How is a user to know what we
mean?  It turns out that in this particular case what we mean is this:

(file-name-nondirectory (or buffer-file-name (buffer-name)))

Not obvious from the description.

To start with, the doc string should say that it prompts for a file
name.  If the current buffer is visiting a file then that file's name is
the default file name for reading.  Otherwise the buffer name is the
default file name for reading.

The last part could be more exact.  The default name in that case is
actually this:

 (expand-file-name (file-name-nondirectory (buffer-name))
                   default-directory) 

In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 10.0.16299
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''



--- End Message ---
--- Begin Message --- Subject: Re: bug#33339: 26; doc string of `write-file` Date: Sun, 11 Nov 2018 18:20:36 +0200
> Date: Sat, 10 Nov 2018 14:42:16 -0800 (PST)
> From: Drew Adams <address@hidden>
> 
>  "If you specify just a directory name as FILENAME, that means to use
>   the default file name but in that directory.  You can also yank
>   the default file name into the minibuffer to edit it, using M-n."
> 
> "The default file name" is undefined.

It is defined by the very next paragraph of the doc string.  I made it
even more clear.

> To start with, the doc string should say that it prompts for a file
> name.  If the current buffer is visiting a file then that file's name is
> the default file name for reading.  Otherwise the buffer name is the
> default file name for reading.

This is incorrect when the user specifies just the directory name at
the prompt.  I clarified that only the base name is taken from the
buffer.

Thanks.


--- End Message ---

reply via email to

[Prev in Thread] Current Thread [Next in Thread]