[Bioperl-l] how to write good POD documentation

[Ewan Birney]

On Thu, 15 Mar 2001, Kris Boulez wrote:

> Quoting Heikki Lehvaslaiho (heikki@ebi.ac.uk):
> > 
> > I've now documented what I learned about bioperl pod documentation and its
> > errors when I cleaned it for the 07 release.
> > 
> > File
> > http://www.bioperl.org/wiki/html/BioPerl/BioperlProgrammingConventions.html
> > has now two sections: Coding conventions and documentation conventions.
> > 
> > Feel free to add more recommendations.
> > 
> 
> I agree completely with these proposed conventions. Certainly the part
> about the SYNOPSIS having to contain runnable code. I went to through
> roughly half of the modules and have working code for the SYNOPSIS'es.
> 
> Is this 0.7.1 or 0.8 issue ?

Both I think ;)


> 
> 
> Kris,
> _______________________________________________
> Bioperl-l mailing list
> Bioperl-l@bioperl.org
> http://bioperl.org/mailman/listinfo/bioperl-l
> 

-----------------------------------------------------------------
Ewan Birney. Mobile: +44 (0)7970 151230, Work: +44 1223 494420
<birney@ebi.ac.uk>. 
-----------------------------------------------------------------