Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Re^2: Perldocs and peer reviews

by g0n (Priest)
on Feb 03, 2005 at 12:55 UTC ( #427610=note: print w/ replies, xml ) Need Help??


in reply to Re: Perldocs and peer reviews
in thread Perldocs and peer reviews

Opinion is divided on the question of a structure. XDG earlier in this thread commented that a structure was possibly unnecessary. I lean more towards your view. A structure, however loose, would provide guidance to reviewers and probably make potential reviewers more willing to comment without a) generating poor quality feedback, or b) putting people off reviewing because they don't want to send poor quality feedback.

Here's a few possible questions:

  • Does the synopsis clearly explain what the module does?
  • Is the syntax of the constructor and any main methods clear from the perldoc
  • Is there any functionality not documented (and therefore probably not present) you would like to see in the module
  • Is the perldoc correctly formatted (and if not, what is the problem and where)?
  • Does the meta data contain a) license, b) language used c) development stage?

As far as brainstorming goes, it might be worth considering opt-in/opt-out of perldoc reviews, setting up a site to post to rather than direct to the author etc. The danger there is that we then potentially start talking about review activity taking place somewhere other than CPAN, which I'm a little dubious about.

c.

Update: Then again, I just looked at recently active threads and found this

VGhpcyBtZXNzYWdlIGludGVudGlvbmFsbHkgcG9pbnRsZXNz


Comment on Re^2: Perldocs and peer reviews

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (17)
As of 2014-07-23 20:38 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (152 votes), past polls