Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight

Re: RFC: Proofread POD for my main random module, please? (more)

by pryrt (Monsignor)
on Jun 01, 2017 at 22:16 UTC ( #1191903=note: print w/replies, xml ) Need Help??

in reply to RFC: Proofread POD for my main random module, please? (more)

  • $color_hash magically appears in your random_color() example usage, and you give no indication of where it comes from (it's not a parameter to your example sub) or what it should look like (other than an arbitrary "hash(ref) of arrays")
  • It takes multiple readings of the POD for me to guess that the data, keys, by keys, ... under the random() function refer to string values of the $color_key argument. Make sure you put quotes around each of the strings, but not around the undef.
  • For tiny_rand(), you might want to mention "a coin flip", and give an example, like tiny_rand("HEADS", "TAILS");. The name is not helpful; maybe rename (or alias) to random_from_two()
  • For instant_rand(), give an example, like instant_rand("HEADS", "TAILS", "EDGE", "EMBED IN CEILING");. Maybe rename (or alias) to random_from_list().

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://1191903]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (8)
As of 2020-11-30 15:00 GMT
Find Nodes?
    Voting Booth?

    No recent polls found