Think about Loose Coupling | |
PerlMonks |
Re: Our documentation sucksby j3 (Friar) |
on Apr 13, 2007 at 15:44 UTC ( [id://609960]=note: print w/replies, xml ) | Need Help?? |
jimt, In general, if you think a module could use better docs, fortunately or unfortunately, the usual road to take is to learn how to use said module using whatever tools are at your disposal (existing docs, mailing list, communications with the author/maintainer, PerlMonks, elbow grease (looking at the source)), and then go ahead and send the maintainer a patch containing proposed improvements to the docs. If you really can't figure out how to use the module, and the author is unresponsive, tell the community about it on cpanratings. Likewise, if the author was helpful, accepted your patch, and the module turned out to be a diamond in the rough (good code, bad docs), you might tell the community about it on cpanratings. Incidentally, I just read this morning that version 0.0.3 of the Perl6::Perldoc suite is now on CPAN. I'm very excited to try this out. Thank you Damian!
In Section
Meditations
|
|