[Bioperl-l] how to write good POD documentation

Heikki Lehvaslaiho heikki@ebi.ac.uk
Wed, 14 Mar 2001 15:31:58 +0000


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.

	-Heikki

-- 
______ _/      _/_____________________________________________________
      _/      _/                      http://www.ebi.ac.uk/mutations/
     _/  _/  _/  Heikki Lehvaslaiho          heikki@ebi.ac.uk
    _/_/_/_/_/  EMBL Outstation, European Bioinformatics Institute
   _/  _/  _/  Wellcome Trust Genome Campus, Hinxton
  _/  _/  _/  Cambs. CB10 1SD, United Kingdom
     _/      Phone: +44 (0)1223 494 644   FAX: +44 (0)1223 494 468
___ _/_/_/_/_/________________________________________________________