On Tue, Mar 14, 2006 at 04:52:18PM +0100, David Landgren wrote: > Hey! It's been over two months since we last had one of these suggestions! > > I did battle with a module that shall remain nameless the other day. I > had a difficult time figuring out how to use it. In times like these, I > like being about to go to the build directory and p(aw|ore) through the > eg/ directory and take a script and bend it into a suitable shape. > > The package in question didn't have an eg/ directory, so I had to spend > far more time studying the source and running it through the debugger > than I really cared to. > > For instance, I know that when I have something tricky to do with > HTML::Parser, I know there's always going to be something close to what > I need to do in the eg/ directory. I think its a good adjunct to POD, > which tends to be more (or should be) more theoretical. > > /eg scripts are a nice "hands-on" way of finding out how a module works > in real life. > > No distribution should be without one! >
Unless, of course, it has an examples/ directory, which would cause the kwalitee test to fail. ;) I do think its a good idea, especially with large, all-encompassing type modules to provide some examples, but testing for (in effect, regulating) the name of the directory that will be difficult to do. Steve Peters [EMAIL PROTECTED]
signature.asc
Description: Digital signature
