Documentation Suggestion

From: Date: Tue, 09 Sep 2003 22:36:15 +0000
Subject: Documentation Suggestion
Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-21304@lists.php.net to get a copy of this message
Hi, A possible solution to all the ire raised over documentation: Why not require API in-code documentation for all package proposals prior to acceptance, and peardoc for all packages prior to the first release (i.e. after package proposals are accepted)? Once people get over the initial hurdle of creating the docs, it's very easy to maintain them/improve them. Packages that have already been released need not be affected, but it would be nice if the developers would follow the lead of Alexey and Stephan and write excellent docs for existing packages. I'm happy to modify the package proposal documentation at pear.php.net to reflect this change if it sounds reasonable. Just to clarify: I'm pretty sure API in-code documentation is already required, the new suggestion is to require documentation as part of pear.php.net in DocBook format prior to the first release of a package, which gives developers assurance their documentation work will not be in vain (Stephan's concern), and that a package will be documented even if it isn't before being accepted (Stan's concern). Regards, Greg

« previous php.pear.dev (#21304) next »