Re: Documentation

> 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? Join the peardoc team ;-) Seriously, I think that most developers won't use undocumented classes. Writing documentation is a skill, and unfortunately, many people who are very good at programming can't write documentation. I know we have a peardoc mailing list, and is a lot of documentation waiting to be built. What needs to be done is for a team to actively work on writing documentation for undocumented packages and improving the documentation that exists. Remember, even those who can write documentation for their programs don't always have unlimited time, so limited documentation isn't always because the programmer can't write it better. We have so many good packages that are completely undocumented except in the source. The difficulty for a documentation team is to sit down, read throught the source, try it out (if they haven't already) and write the documentation. For a single package it can take a _long_ time because only the programmer is really familliar with it enough to be able to write documentation without taking time to get to know it thoroughly. I'll see what I can do about writing documentation for undocumented classes I use and improving the documentation for those that already have it. As has been said, examples need to be short and sweet, and have line-by-line comments. Realize, PEAR was just released recently, is still very new (even if it partly existed in previous PHP releases). We're moving in the right direction... good things take time :-) Klaus > Just my 2 cents > > Daniel Khan > > > -- > PEAR Development Mailing List (http://pear.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php