Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

comment on

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

I started by downloading your .pl code and then generating the HTML. I only looked at the HTML doc, not your code in this review. Looking at the code would perhaps solve lots of questions, but that is not the point of a doc review.

I don't understand the main purpose of this module other than it has something to do with randomizing things. Randomize what? And why? How does your module do much more than obvious uses of the standard Perl rand functions?

Why is there a separate tiny_rand() from instant_rand()? Why the need for 2 functions? As for naming why wouldn't a "tiny" one be "instant"?

As a naive person to your topic, I just do not understand what this thing is supposed to do.
I am not trying to "rain on your parade". But, I think the doc's could be improved. superfluous comment deleted.

update: Starting to look at the actual code and I agree with Re: RFC: Proofread POD for my main random module, please? (more) from pyrt in regards to "tiny_rand()" and "instant_rand()". I would think random_from_list() as pyrt suggests is more understandable. I don't see a reason to expose the 2 parameter version of "instant_rand()" as "tiny_rand()" unless there is some significant performance reason to do so.


In reply to Re: RFC: Proofread POD for my main random module, please? (more) by Marshall
in thread RFC: Proofread POD for my main random module, please? (more) by Lady_Aleena

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, 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?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others surveying the Monastery: (7)
    As of 2019-09-21 02:37 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      The room is dark, and your next move is ...












      Results (269 votes). Check out past polls.

      Notices?