•Re: PodHead Census


Welcome to the Monastery
	PerlMonks

•Re: PodHead Census

by merlyn (Sage)

on Dec 12, 2003 at 15:31 UTC ( [id://314329]=note: print w/replies, xml )

Need Help??

in reply to PodHead Census

You can't just make the rubrics up. One primary target of POD is the manpages, and the manpages have specific heads for specific purposes. So things like "name" and "synopsis" are dictated by longstanding convention created two decades before Perl, and it would be unwise to ignore such a relationship. See "man 7 man" for details.

-- Randal L. Schwartz, Perl hacker
Be sure to read my standard disclaimer if this is a reply.

Comment on •Re: PodHead Census

Replies are listed 'Best First'.

Re: •Re: PodHead Census
by simonm (Vicar) on Dec 12, 2003 at 23:23 UTC

See "man 7 man" for details.

Thanks. (Sadly, Mac OS X seems to omit this manpage, but I found it online.)

The sections headings they refer to as "traditional" are NAME, SYNOPSIS, DESCRIPTION, OPTIONS, FILES, SEE ALSO, DIAGNOSTICS, BUGS, and AUTHOR. (The only required one is NAME, which must follow the "name - brief description" format.)

A quick comparison shows that most of those headings are among the most common in module POD documentation.

[reply]

In Section Meditations