Re: New Volunteer ?

On Sun Feb 01, 2004 at 07:2653PM +0100, David Costa wrote: > Okay, on the pure PEAR packages I would be glad to start tomorrow on > > Date and Time (2) > Calendar, Date Calendar already seems to documented. > Mail (4) > Mail, Mail_Mbox, Mail_Mime, Mail_Queue Mail and Mail_Mime are also documented. > Then I can move on with something else provided that what I do is > satisfactory. Now, I would need a sample "idea pear package > documentation" to be sure on the expected outcomes. Back when I wrote the documentation for XML_RSS, I felt like it was appropriate for someone to start using the package from scratch. Another example is probably the documentation for HTTP::redirect, which contains everything one needs in order to use the functionality.. And if you feel like writing very extensive documentation for a package, you might be interested in the way, in which the Log package is documented [1]. Generally you don't need to attach too much time to documentation that describes the API of the package, as this will be covered elsewhere in the future. Usage examples are more important. > I assume the format is the same as php main docs, XML . Yes. It is placed in the CVS module "peardoc". [1] http://www.indelible.org/pear/Log/guide.php -- - Martin Martin Jansen http://martinjansen.com/