Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

Kudos. That is a really great idea for eliminating annoying typos in POD -- somehow, I always seem to catch a typo after I've released to CPAN (something to do with the really nice POD2HTML formatter they have, I guess). However... at the risk of reopening the Test::Pod/Test::Pod::Coverage flamewar, I'm also really glad that you caution in your docs about including a test like this in a distribution because of the the new dependency chain it adds:

  • Pod::Spell and Test::Spelling have to be installed (or downloaded and installed) or tests will fail (though smart use of eval "require ..." can address that)
  • The Pod::Spell version with stopwords needs to be the same as what you tested before release to not let something unexpected through (though it's not been updated since 2001, so that may not be much of an issue)
  • It relies upon an external spell checker program, which may or may not exist or exist by the hardcoded name provided

The way I see it, unless one is only writing for internal use or for someone with exactly the same system setup that one has, there are going to be a lot of spurious failures and frustrated downloaders.

If someone wants to check spelling with a .t file, I'd recommend not including it in the MANIFEST (and adding it to MANIFEST.SKIP) so it stays internal for one's own development purposes.

For your "todo" list -- I suggest having it skip gracefully instead of failing if it can't find the external spell checker.


Code written by xdg and posted on PerlMonks is public domain. It is provided as is with no warranties, express or implied, of any kind. Posted code may not have been tested. Use of posted code is at your own risk.

In reply to Re: Improve the speling for you moduels documention by xdg
in thread Improve the speling for you moduels documention by itub

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, 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, 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.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others meditating upon the Monastery: (6)
    As of 2018-06-19 16:40 GMT
    Find Nodes?
      Voting Booth?
      Should cpanminus be part of the standard Perl release?

      Results (114 votes). Check out past polls.