Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic

comment on

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

My $0.02 ...

When I download a module from CPAN, I expect never to look at its source-code, and, most importantly, to never feel that I have to.   Most of all, I want to see a long list of self-tests that rigorously exercise the module.   Secondarily, I want to see thorough documentation that doesn’t require deep knowledge of the code (or, any knowledge at all of the code) in order to use it effectively.   I do not want to get the impression from the POD that the code is half-baked:   I have passed over many a module for that reason.   The design of a module intended for public use must be very considerably more stringent than simply taking a piece of code that you wrote for a project and making it public.   Obviously some serious thought must be given to how you intend for the module to be used, and for keeping the code as isolated from unwanted side-effects as possible.   But I am not going to dive into your code and critique it.   I’m not going to try to understand it.   Indeed, the very reason why I am seeking code from CPAN is so that I don’t have to understand it.

One other thing that I look at is the CPAN bug-list.   Are you fixing reported bugs in your code within, say, just a couple days of it being reported?   If the code begins to fail CPANTS tests (e.g. because some original prerequisite module has changed), are you Johnny-on-the-spot?

In reply to Re: In Need of Mentoring by sundialsvc4
in thread In Need of Mentoring by qazwart

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or or How to display code and escape characters are good places to start.
Log In?

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

How do I use this? | Other CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (3)
As of 2021-05-13 00:16 GMT
Find Nodes?
    Voting Booth?
    Perl 7 will be out ...

    Results (134 votes). Check out past polls.