Re: RFC - Acme::Dice

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

Comment on Re: RFC - Acme::Dice Select or Download Code

Replies are listed 'Best First'.
Re^2: RFC - Acme::Dice by boftx (Deacon) on Oct 16, 2013 at 23:24 UTC
Hi, Ken. Good catch on `dice_craps`, I've changed those lines to `roll_craps`. I checked several of the other dice modules, and most of them I saw used the RPG notation (3d6, etc.) to specify the conditions. I felt that people outside the RPG community might not immediately recognize that, and those within it would not have a problem with distinct params. I also checked one that allows for "loaded" dice and felt it was a little too hard for one without a math or statistics background to grasp. Mine is more of a "gut-feel" approach, but given this is Acme, it seemed appropriate. :) I've also added an explicit statement that nothing is `EXPORT`ed by default as you suggested. Thanks for the great input! The answer to the question "Can we do this?" is always an emphatic "Yes!" Just give me enough time and money.	[reply] [d/l] [select]

Replies are listed 'Best First'.

Re^2: RFC - Acme::Dice
by boftx (Deacon) on Oct 16, 2013 at 23:24 UTC

Hi, Ken. Good catch on dice_craps, I've changed those lines to roll_craps.

I checked several of the other dice modules, and most of them I saw used the RPG notation (3d6, etc.) to specify the conditions. I felt that people outside the RPG community might not immediately recognize that, and those within it would not have a problem with distinct params. I also checked one that allows for "loaded" dice and felt it was a little too hard for one without a math or statistics background to grasp. Mine is more of a "gut-feel" approach, but given this is Acme, it seemed appropriate. :)

I've also added an explicit statement that nothing is EXPORTed by default as you suggested.

Thanks for the great input!

The answer to the question "Can we do this?" is always an emphatic "Yes!" Just give me enough time and money.

[reply]
[d/l]
[select]