Re: Documentation

From: Date: Sat, 26 Apr 2003 08:28:33 +0000
Subject: Re: Documentation
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-15566@lists.php.net to get a copy of this message
Nope. Although there was levity in there, the core of the comment is made > in total seriousness. I like to avoid reading the code unless I suspect a > bug. Yes, I can read the code quite easily, but it takes time to do so. I > read a lot about how PEAR is trying to become CPAN for PHP, and how it's > going to dominate the world, etc. I'm trying to poke a few developers into > making that happen, because it sure as hell isn't going to happen when the > entire documentation for a class doesn't mention how to do the *main* > *thing* *the* *class* *exists* *for*. > 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> Mirco

« previous php.pear.dev (#15566) next »