Hm, I was thinking about more sophisticated examples, showing distinct, common use cases. That is, for example, code which is too lengthy to be included in the POD. Maybe something that will run out of the box. I'm looking for a place for code that I consider disturbing when included in the modules documentation. Imagine an API with some common use cases. Present them as a fully working script allows a programmer to get started easily.
Of course, always in addition to a good synopsis :) > Am 09.10.2014 um 23:16 schrieb Sebastien Feugere <seb.feug...@gmail.com>: > > You can put a simple example in the POD's "SYNOPSYS" section of your module > as you can find on most of Perl modules (check a random CPAN module to see). > > See : > * http://juerd.nl/site.plp/perlpodtut > * http://perldoc.perl.org/perlpodstyle.html > > > ~$&bast1 > >> On Thu, Oct 9, 2014 at 10:52 PM, Alex Becker <asb.c...@gmail.com> wrote: >> Hi all! >> >> Similar to my question about the lib folder of a Perl module, I would like >> to knoe where one should put example scripts in a CPAN distribution. >> >> I've seen modules using an eg folder and I'm always tempted to use a more >> mnemonic version: examples. >> >> Is there a best practice? I know of TIMTOWTDI but I don't care, I just want >> to deliver something that people can easily use. >> >> Thanks in advance & kind regards, >> Alex >
