bug#28957: 26.0; doc string of `dired-move-to-filename'

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

bug#28957: 26.0; doc string of `dired-move-to-filename'

Drew Adams
Please describe the parameters, RAISE-ERROR and EOL, in the doc string.

In GNU Emacs 26.0.90 (build 3, x86_64-w64-mingw32)
 of 2017-10-13
Repository revision: 906224eba147bdfc0514090064e8e8f53160f1d4
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''



Reply | Threaded
Open this post in threaded view
|

bug#28957: 26.0; doc string of `dired-move-to-filename'

Lars Ingebrigtsen
Drew Adams <[hidden email]> writes:

> Please describe the parameters, RAISE-ERROR and EOL, in the doc string.

Nah.  Those parameters are so obscure that you'd have to put the entire
function in the doc string to explain them.  Especially RAISE-ERROR.

--
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no



Reply | Threaded
Open this post in threaded view
|

bug#28957: 26.0; doc string of `dired-move-to-filename'

Drew Adams
> > Please describe the parameters, RAISE-ERROR and EOL, in the doc string.
>
> Nah.  Those parameters are so obscure that you'd have to put the entire
> function in the doc string to explain them.  Especially RAISE-ERROR.

That's a cop-out, and it flouts Emacs convention.  Users
deserve better.

Your comment is of course welcome.  But closing the bug
is inappropriate - c'est un bug.

If you don't want to fix it, or you don't know how, why
not at least leave it open for someone else to fix who
might want to and knows how?

Are you not finding enough Gnus bugs to close? ;-)