Re: Re: Is your package really documented? The truth
| From: | David Costa | Date: | Fri, 30 Apr 2004 17:03:59 +0000 |
| Subject: | Re: Re: Is your package really documented? The truth | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-28644@lists.php.net to get a copy of this message | ||
On Apr 30, 2004, at 5:35 PM, Paul M Jones wrote:
$yes means only "documented on pearweb directly" or can it mean "documented elsewhere but linked on pearweb"?$yes means not documented on http://pear.php.net/manual/index.php A package with the basic documentation and external link is present on the manual thus documented. I think by not documenting some developers are losing a great opportunity, if your package doesn't show on the manual some people might not even know it exist. Let alone if they download the manual :D
$no means only "not documented on pearweb directly" or can it mean "not documented anywhere at all"?$no means there are no documents or better no entry for that package on the manual. In some cases they are documented externally, then they need to prepare the skeleton docs for docbook, or ask me to do it or I am working on a script do produce some skeletons on the fly, (can't promise it will work thou). Cheers David Costa
-- Paul M. Jones Savant: the simple alternative to Smarty for PHP. http://phpsavant.com/ DB_Table: build RDBMS tables and XHTML forms in one PHP class. http://wiki.ciaweb.net/yawiki/index.php?area=DB_Table Yawiki: your collaborative online documentation system. http://wiki.ciaweb.net/yawiki/index.php?area=Yawiki