[Bioperl-l] how to write good POD documentation

Kris Boulez krbou@pgsgent.be
Thu, 15 Mar 2001 10:23:26 +0100

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 ?