[PEPr] Comment on PHP::PHP_Fork
| From: | PEPr | Date: | Wed, 03 Mar 2004 12:32:00 +0000 |
| Subject: | [PEPr] Comment on PHP::PHP_Fork | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-26057@lists.php.net to get a copy of this message | ||
David Costa (http://pear.php.net/user/gurugeek) has commented on the proposal for PHP::PHP_Fork.
Comment:
Hello Luca!
I am one of the PEAR Doc volunteers. I checked your initial docs, albeit fine you should include
more comments and examples. To some extend this can be done with a properly commented source: this
will allow phpdocumentor to generate a really good/acceptable documentation.
While what you did is certainly good for an expert user, some might need a clear documentation with
examples so you should try to look at other packages or ask Greg re: how to enhance the
phpdocumentor functionality and generate almost perfect docs on the fly.
I appreciate that documentation is not the first concern for a developer, but if you want your
package to be successful, you should consider a mode detailed documentation.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=24
--
Sent by PEPr, the automatic proposal system at http://pear.php.net