Huge misakes? Not that I can see. Automatic A++ for even using POD. The bulk of the
feedback you receive may end up having more to do (IMO) with POD's placement inline functions versus at the end. I know the merits of each and have the debates before, even at
$WORK (related issues include: maintenance, Lukes using the source to augment module understanding, etc; however I get it, it all looks the same when rendered). My personal preference is all at the bottom as a monolith and
*.pod is only useful for cookbooks and tutorials. Minor nits:
DESCRIPTION typically goes immediately after
SYNOPSIS; and I think there's a standard way the
NAME section is written so CPAN gets the description right. Also, looking at other well known module POD is always informative. Good job.
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.