My favorites | Sign in
Logo
                
Search
for
Updated Jul 01, 2009 by dan...@percona.com
PODHeadings  
Standard order of POD headings

The following POD headings (and corresponding paragraphs) should be present in every script in the following order. Optional headings/paragraphs can be placed between the standard headings where noted:

  • NAME
  • SYNOPSIS
  • DESCRIPTION
  • optional: other description-related paragraphs
  • OPTIONS
  • optional: todo/options not yet implemented
  • DOWNLOADING
  • ENVIRONMENT
  • SYSTEM REQUIREMENTS
  • BUGS
  • COPYRIGHT LICENSE AND WARRANTY
  • optional: SEE ALSO
  • AUTHOR
  • optional: acknowledgements, historical side-notes, etc.
  • VERSION

Use maatkit/check-pod to check the PODs (see DeveloperUtilities).

Hosted by Google Code