Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

Re: seek harsh critique

by Laurent_R (Canon)
on Dec 08, 2017 at 17:33 UTC ( [id://1205192]=note: print w/replies, xml ) Need Help??


in reply to seek harsh critique

Hi coyocanid,

I am not quite sure where the synopsis actually ends (perhaps because of the missing section corresponding to the ellipsis ...), but I have the feeling it might be too long for a synopsis, which is supposed to be a brief summary.

Replies are listed 'Best First'.
Re^2: seek harsh critique
by stevieb (Canon) on Dec 08, 2017 at 18:18 UTC

    I agree with the SYNOPSIS here.

    I prefer a nice short synopsis that has a couple of very short scenarios (although I am guilty of a few longer ones myself for various reasons). I would remove most of the #SECTION pieces out of synopsis and put them into an EXAMPLES section. If you do the POD correctly, your EXAMPLES section will be listed at the top of the page at MetaCPAN, and the sub-sections will be visibly listed, and a link generated to take you directly to that section:

    =head1 EXAMPLES =head2 Setting data ... =head2 Getting data ...
      Good ideas, thanks for the feedback.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (4)
As of 2024-04-26 06:44 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found