Re: taking care of tomas's packages
| From: | David Costa | Date: | Wed, 25 Feb 2004 20:21:01 +0000 |
| Subject: | Re: taking care of tomas's packages | ||
| References: | 1 2 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-677@lists.php.net to get a copy of this message | ||
On Feb 25, 2004, at 7:26 PM, Stefan Neufeind wrote:
I'm sure that volunteers to write phpdoc-comments would also be very much appreciated, yes. Are you thinking about any packages in special?So far I did net-geo, net-smtp and net-ipv4. If I can fix the bug on http-upload I will need to do the documentation too, or the documentation first then the bugs.
A first thing should be to check back with the leads as a first step. Another might be that if no phpdoc / insufficient are supplied and no doc is yet available this might also be on the list for "allowed PEAR QA actions" from my view - for all packages that are in CVS and accept QA-commits (as suggested by Lukas in the other thread). I think the problem is the way some developers do their documentation. It is normally in the package, so the examples so is not the case of bad/missing docs.The issue is having their source comments to work with PhpDocumentor they right way. For some packages, the output is missing a lot of tag and the XML
comes out as ¬documented; This is again not a PhpDocumentor issue. Some packages like game-chess are properly commented and therefore the output is really 99% perfect.
PS: Basically all devs in the PEAR QA-team should allow QA-actions on their packages :-))
I just think that new packages should either come with the XML docs done by the developer or the proper comments for phpdocumentor.We can certainly add the docs to the existing packages, one by one, but if new packages are submitted and accepted with the same problems this will potentially become a never ending problem. Regards,
David Costa, PostgreSQL Advocate http://dotgeek.org david at postgresql ddoot org gurugeek att php dot net$dsn = 'pgsql://world:most_advanced@localhost/open_source_database';