emacs-devel
[Top][All Lists]
Advanced

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

Re: Uncomprehensible DOC string


From: David Kastrup
Subject: Re: Uncomprehensible DOC string
Date: Fri, 09 May 2008 10:30:11 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/23.0.60 (gnu/linux)

Michael Albinus <address@hidden> writes:

> David Kastrup <address@hidden> writes:
>
>> That addresses the last partial sentence of my report.  What about the
>> rest?  There is no sense to leave a fragmentary explanation in the DOC
>> string when you need to read up the function's behavior elsewhere,
>> anyhow.  The manual reference should be there to explain the _terms_
>> used in the DOC string, but the DOC string should still be _complete_
>> once the terms are clear.
>
> I'll try to be a little bit more comprehensive in the doc
> string. However, I don't believe that the doc string of
> `start-file-process' is the place to explain what are file name
> handlers at all.

No, but saying a file name handler will be called based on
default-directory without telling what the file name handler is actually
supposed to be processing is not much use I think.  The command?  The
command line arguments?  The executable?

-- 
David Kastrup




reply via email to

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