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

Re^2: The problem of documenting complex modules.

by 1nickt (Canon)
on Jul 08, 2015 at 14:42 UTC ( [id://1133727]=note: print w/replies, xml ) Need Help??


in reply to Re: The problem of documenting complex modules.
in thread The problem of documenting complex modules.

Your demo code is excellent and I urge you to go file a PR with it today :-)

In my experience the more concise and clear the change you are proposing, the more likely it is to be applied.

The module authors are no doubt busy, and if they can scan and understand your proposed change in two seconds, and especially if it's to the docs, they are very likely to hit the "merge" button. If they have to squint, or spend more than ~15 seconds understanding your change, the button is not gonna get pressed. Not at that moment when they get the email about your PR. And after that, who knows when.

Remember: Ne dederis in spiritu molere illegitimi!

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others wandering the Monastery: (7)
As of 2024-04-23 09:44 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found