Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: The problem of documenting complex modules.

by planetscape (Chancellor)
on Jul 07, 2015 at 05:06 UTC ( [id://1133502]=note: print w/replies, xml ) Need Help??


in reply to The problem of documenting complex modules.

I do know that (for me) the single most important thing in encouraging my use of a module is being able to C&P the synopsis into my existing program, tweak the variable names, and have it do something useful immediately.

I wholeheartedly agree. A personal pet peeve is the - thankfully rare - bit of synopsis code that doesn't work, or worse, errors. I immediately dump that module and start looking for another.

HTH,

planetscape
  • Comment on Re: The problem of documenting complex modules.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (1)
As of 2024-05-23 15:27 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found