G'day Jim,

Generally, the doco looks fine, inasmuch as it was easy to read and conveyed how to use the module.

There is a problem in the SYNOPSIS: two instances of dice_craps should be roll_craps; or, alternatively, four instances of roll_craps (in various parts of the doco) should be dice_craps. Given you wrote "No, it is NOT craps!", at the start of the post, I was a little surprised to find any functions referring to craps.

I don't know if you were planning to upload this to CPAN. Just be aware that there's already a lot of dice-related modules on CPAN. I'll leave you to check whether your proposed module adds any functionality not already covered: if it does, it would be worth adding an indication of whatever that might be to the doco.

Something I often look for in module documentation is whether anything is exported by default. As yours doesn't: consider adding a note to this effect (possibly right before "The following functions are available as imports.").

I had a very brief look at the code: nothing leapt out at me as being particularly wrong.

-- Ken

In reply to Re: RFC - Acme::Dice by kcott
in thread Released - Acme::Dice by boftx

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.