GNU bug report logs - #30634
26.0; doc string of `dired-do-create-files'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 30634 in the body.
You can then email your comments to 30634 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0; doc string of `dired-do-create-files'
Date: Tue, 27 Feb 2018 10:12:18 -0800 (PST)

The doc string says this, where "into-dir" is the only occurrence of
that text in the doc string:

   The rest of into-dir are optional arguments.

This is incomprehensible.  Yes, in the _code_ of the function there is
an internal, local variable named `into-dir', but it makes no sense to
refer to that in the doc string.

---

(The entire description of arg HOW-TO is too complicated, particularly
the "Otherwise" part.  Apparently in this case HOW-TO is a function.  If
that function returns a non-nil list then its car is a function of 4
args...  An example or two might help.)


In GNU Emacs 26.0.91 (build 1, x86_64-w64-mingw32)
 of 2018-01-22
Repository revision: 752fba992b793a74d202c9cfc3e1a92fd458e748
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

Message #10 received at 30634-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 30634-done <at> debbugs.gnu.org
Subject: Re: bug#30634: 26.0; doc string of `dired-do-create-files'
Date: Thu, 01 Mar 2018 17:32:45 +0200

> Date: Tue, 27 Feb 2018 10:12:18 -0800 (PST)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> The doc string says this, where "into-dir" is the only occurrence of
> that text in the doc string:
> 
>    The rest of into-dir are optional arguments.
> 
> This is incomprehensible.  Yes, in the _code_ of the function there is
> an internal, local variable named `into-dir', but it makes no sense to
> refer to that in the doc string.

Thanks, fixed.

> (The entire description of arg HOW-TO is too complicated, particularly
> the "Otherwise" part.  Apparently in this case HOW-TO is a function.  If
> that function returns a non-nil list then its car is a function of 4
> args...  An example or two might help.)

I didn't see it as overly complicated, I think it's very clear.

Previous Next

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