Re: PEAR Documentation useless while ...

1.) PEAR *is* an API of sorts, thus it makes sense that the documentation *feels* like API documentation. 2.) I think I speak for all package maintainers when I say that we'd never turn down decent user submitted documentation. --Joe -- Joseph C Stump PHPTraining.net Professional PHP and MySQL Training http://www.phptraining.net (734) 786 0176 On Aug 9, 2004, at 11:40 PM, Alfonso Baqueiro wrote:

The documentation in pear site is the kind of API documentation, like the java api documentation, but in fact that kind of documentation is only useful if you have a knowledge of the purpose of the clases and the problem that they try to solve. Another failure in the documentation is there are a lot of packages that does not have documentation. The utilization of PEAR repository can be improved if is included in the documentation some examples of utilization of the classes solving real problems, an example is more useful and educative and can give a fast general vision of the class utility, that allows to the people using the class to hack the code for search details of the class. Other important aspect that can be a plus is if the classes include anotations on the analysis of the problem, design decisions, the problems find in the implementation and the clever ideas that allow to round the problems. With who can i discuss this kind of things? -- PEAR General Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php