On Sun, Jul 18, 2010 at 6:27 PM, Zeno Gantner <zeno.gant...@gmail.com> wrote: > Hi all, >
Hi Zeno, > during a train ride w/o internet access I went through the plug-ins in > the Padre repository to try out some of them (I was bored ;-), and found > that many of them lack documentation, in particular README files. > > I know, coding is more fun than documenting stuff (at least for most > people), > so I understand that this is often not done properly. > However consider that people are more likely to try out your plug-in if > they have an idea what the plug-in is useful for, and will also put more > trust into your code if it is nicely documented. > As the author of a couple of Padre plugins out there, I must confess I never really bothered to make the README file anything other than the boilerplate. My reasoning was simple enough, though I'm not particularly proud of it: I don't think I ever read a README file for a Perl module. I mean, before it's installed I look for the html Pod in http://search.cpan.org. During installation, cpan goes a long way for me. And afterwards, perldoc usually shows me what I want. Am I missing something here? Also, regarding Padre plugins, I think the "go pod" thing is also part of the mentality, in which you should never have to manually download and install any of them. And you can usually view plugin documentation (in Pod format, not as a README file) in Tools -> Plugin Manager on the main Padre menu bar. Either way, I'll look at your "okay" plugins and update the README of my plugins. Thanks for the report :-) Cheers, garu _______________________________________________ Padre-dev mailing list Padre-dev@perlide.org http://mail.perlide.org/mailman/listinfo/padre-dev
