Re: Documentation problem...



* Emmanuele Bassi <bassi-e libero it> [2004-06-02 13:31]:
But you should not use the code in the SYNOPSIS [...], since
it's *very* dumb.  There are various examples in the examples/
directory [...] (and they all work :-)).

Just a note in case you didn't know: you can easily test the code
in your POD using Test::Inline!  :-)  The Perl advent calendar
entry for Dec 10, 2003 [1] has a couple examples of the use of
Test::Inline specifically for this purpose (unlike the bundled
Test::Inline::Tutorial which doesn't really advertise testing
code snippets from the documentation as a use of the module).

[1] http://www.perladvent.org/2003/10th/

-- 
Regards,
Aristotle
 
"If you can't laugh at yourself, you don't take life seriously enough."



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]