G'day Bod,

I always start my POD with: 

=encoding utf8

[download]

It's part of my template for module code so I don't have to do anything manually to get this. See "perlpod: =encoding encodingname" if you're unfamiliar with this POD command.

"... under the same terms as the Perl 5 programming language system itself."

This looks strained (for want of a better word). I'd remove the word "system"; and consider whether I even want "itself".

"Why is it you only find typos after publishing?"

Checking your own work is not the best idea because your brain already knows what you meant and that's what it tends to see. However, if you're like me, you don't have the benefit of a proof-reader on hand. I generally try to read POD in different contexts:

Each of those will likely provide a slightly different view; typos will tend to be more prominent. Changing the width of your screen may also give a different view; I can never be bothered to go to that much effort.

I see you have 't/pod.t' with Test::Pod which should pick up typos in POD commands (e.g. =begun); and 't/pod-coverage.t' with Test::Pod::Coverage which should pick up typos in subroutine names. However, these are set up as "Author tests" and, from "Test::More fails...", you don't seem to be running these: 

t/manifest.t ...... skipped: Author tests not required for installatio
+n
t/pod-coverage.t .. skipped: Author tests not required for installatio
+n
t/pod.t ........... skipped: Author tests not required for installatio
+n

[download]

Those are messages for users installing your module; you should do `export RELEASE_TESTING=1` before your `make test` (or similar; e.g. I see gmake test in that post).

In addition, there are other Test::Pod::* modules which you may find helpful. I don't use any of these, so I'll make no recommendations, but I see some for checking spelling, links, and so on. Search for these from MetaCPAN.

— Ken

In reply to Re: RFC - Documentation Review by kcott
in thread Please review documentation of my AI::Embedding module by Bod

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • 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:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.