Re: AW: [PEAR-DEV] Documentation
| From: | Matthew Palmer | Date: | Sat, 26 Apr 2003 13:13:57 +0000 |
| Subject: | Re: AW: [PEAR-DEV] Documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-15574@lists.php.net to get a copy of this message | ||
On Sat, 26 Apr 2003, Daniel Khan wrote:
> 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?
Deprecate any package which does not have at least some attempt at
documentation. Allow and encourage properly documented replacements for
undocumented packages. Do not give approval for packages which do not at
least make a token effort at documentation. Put in the PEAR coding
standards (in fact, I think it's there already) that if it isn't documented,
it effectively doesn't exist - to the point of not allowing it into the
downloadable part of PEAR without being checked first for documentation, if
that is necessary.
Draconian, probably. Necessary - well, if PEAR wants to become a true
resource for the PHP community, rather than just another source of two-bit
modules which are less effort to reimplement...
--
-----------------------------------------------------------------------
#include <disclaimer.h>
Matthew Palmer, Geek In Residence
http://ieee.uow.edu.au/~mjp16