Re: New Volunteer ?

On Feb 1, 2004, at 8:06 PM, Martin Jansen wrote:

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.

sorry, missed the crucial chapter on docs :) but..for instance on mail I don't see the description for Mail_Queue and Mail_Mbox, can I do that ? next try : I see 3 packages documented on db, can I try one of the non documented ? (e.g. db relational, db_query_tool)

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..

Okay I will use that as a sample

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 will stick with usage samples then.

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

will do, if the missing mail and db are fine I should have the first one by tomorrow. Cheers David Costa