[Top][All Lists]

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

Re: Changes in revision 114466

From: Stephen Berman
Subject: Re: Changes in revision 114466
Date: Mon, 30 Sep 2013 12:29:26 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux)

On Sun, 29 Sep 2013 22:21:18 -0700 (PDT) Drew Adams <address@hidden> wrote:

>> But I see one problem: not every {functions, variables, ...} needs
>> documenting.  E.g., some functions/variables use two hyphens to separate
>> prefix.  These functions/variables usually don't needs documenting.
> Why not?  Do you think developers do not need documentation?

According to Stefan Monnier (see

   [These functions/variables are] not meant to be used by other
   packages [, which] means that something defined with "--" can
   completely change (or disappear) from one release to the other.

This suggests that developers who use them should be working on the
package they are in, hence reading and using the code and commentary of
that package.  In contrast, documentation for developers is, I think,
aimed at explaining the code's public interface to use in developing
other packages, not its private, internal only interface (at least the
documentation in the manual; such functions/variables could have doc

Steve Berman

reply via email to

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