http://qs321.pair.com?node_id=1133502


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