On Tue, Dec 28, 2004 at 11:57:44PM -0500, David Manura wrote:
> Why are "functions, methods and things" (i.e. "API") given in a head2 
> section rather than a head1?

Because they're all subheadings of DESCRIPTION.  Don't nit-pick too far
into it, its just a common convention and this tutorial should just follow
convention.


> Second, a large module can have many subroutines, and these subroutines 
> may be classified and grouped into subsections for clarity (e.g. public 
> v.s. private, method v.s. function, static v.s. instance, or by 
> category).   If the API is a head2, then these might be head3's to 
> distinguish them from potentially many description subsections, and each 
> subroutine would be further nested into a POD list.  The nesting is 
> getting deep.

Keep in mind this is a 5 minute intro for first time module authors.
Large scale POD formatting issues like this are quite beyond its scope.


-- 
Michael G Schwern     [EMAIL PROTECTED]     http://www.pobox.com/~schwern/
Don't be a lover, girl, I'd like to shamelessly hump your inner child.

Reply via email to