AW: [PEAR-DEV] Documentation
| From: | Daniel Khan | Date: | Sat, 26 Apr 2003 08:58:36 +0000 |
| Subject: | AW: [PEAR-DEV] Documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-15568@lists.php.net to get a copy of this message | ||
Mirco 'meebey'Bauer wrote:
[..]
> I agree with this, I got the same problem a while ago, my
> solution was simlpy not to use PEAR packages without any documentation...
> I know its bad, but I tried already to show some PEAR developers the
> need of documentation. On the discussion it ended up with "you know I
> spent alot time for PEAR coding, and I don't have time for doing
> documentation too..."
>
> <IMO>
> when _I_ use libraries from other developers, I don't want to see their
> code. I know mine thats how it should be.... searching in others code
> for how things work is pain, because you usually don't know the design
> of the library (gets worse when the library is splitted in different
> classes and files).
> Also I hear often, "I got examples, thats documentation...", examples
> are only a part of documentation, they don't explain much about the
> library itself... also having for every situation an example is not
> possible for big libraries...
> </IMO>
ACK - BUT what can be done to solve the problem?
There is no realistic way to force one to write a propper docu.
And to demand a full docu on package proposal isn't the right way either I
think.
What shall be done with existing, important, packages without docu?
Just my 2 cents
Daniel Khan