[Biopython-dev] Why don't we start the documentations as well?

[Jeffrey Chang]

That would be useful.  What you're proposing sounds like a reference
book that would complement Brad's tutorial and cookbook.  How do you
think it should be maintained?  In the Wiki or some other way?  Also,
how would we handle the versioning, e.g. if a function changes from
one version to another in Biopython?

Jeff



On Thu, Jun 27, 2002 at 03:38:18PM +0200, Yair Benita wrote:
> Hi All,
> If the faq has already been updated why don't we go further and do something
> about the documentation.
> I suggest we make a template for each module. Something like:
> 
> Module X: the function of this module
> For each class:
> Class y: description of the class
> Attributes: attribute name and the value returned.
> Methods: what the method is doing and what value is returned.
> 
> It should be a library on the biopython web-site which is constantly updated
> as modules are submitted or changed. Any of us, when he has time can
> complete an online form of the template and submit it for review to those
> who have access to the web site. That way we can share the burden of
> documenting.
> 
> We can start with minimal documentation on each module and complete it with
> time.
> Yair
> -- 
> Yair Benita
> Pharmaceutical Proteomics
> Utrecht University
> 
> _______________________________________________
> Biopython-dev mailing list
> Biopython-dev at biopython.org
> http://biopython.org/mailman/listinfo/biopython-dev