develooper Front page | perl.perl5.porters | Postings from December 2000

Re: =code language ... =back in POD

Thread Previous | Thread Next
From:
Tels
Date:
December 12, 2000 16:00
Subject:
Re: =code language ... =back in POD
Message ID:
200012122330.SAA388904@www08.hway.net
-----BEGIN PGP SIGNED MESSAGE-----

Moin,

On 12-Dec-00 Jarkko Hietaniemi tried to scribble about:
> In the ideal case one would also be able to specify the input (command
> line arguments, input files, etc) and the expected output.

Only if the example is actually run. But I intend to check the syntax
(compilable), not the input/output (runnable).

Me thinks examples are to give syntax, not actually runnable code (except
for really big examples). Very often the setup etc is missing in the
examples, whic is ok by me, but makes them unrunnable, anway.

What I really like about Perl are the testcases, that prevent old bugs from
cropping up again. For the doc, this is missing, every change in the code
(api!) or the doc can outdate the doc or invalid it. Would be cool if
authors had an automated test-tool that quick-checks the examples in the
doc for syntax errors. ;)

Cheers,

Tels

- --
 "Why do you go so slowly? Do you think this is some kind of game?"
 http://bloodgate.com/thief/     Thief - The Dark Project
 http://bloodgate.com/aifilter   Rewriting the HTML as we know it.
 http://freedomforlinks.de       Fight for your right to link. 
 PGP key available on http://bloodgate.com/tels.asc or via email.


-----BEGIN PGP SIGNATURE-----
Version: 2.6.3i
Charset: latin1

iQEVAwUBOja1uncLPEOTuEwVAQGOjQf+MFMFvaF47FBt79YFqL2Kp2XJK5vqSc+c
YTXyIXL+Dw9GGgF2m6onemU+bnBP6eF6Kte12Sje5k2VlbDMbpyTMiMd5p56yOom
ii3eLaLSq73wm4yC2o9a5xRbxAvCTtK/JJLvBWQJrbL31+cKEpMif/8Cc8a2uLFy
1K+K71GsEiFwn5dhNAKMj+Y+lJPK2AqYDN65FgyePnHXvqf7fXdF3qJADTLgp/UJ
b91hm5KGzXJOSYgHEpK6ZncfHmX2Zg/qkJ2C2eBqcQ6CmosP9CMMh5JL0TIFX1rU
C4vC+kW6GrpuQKn5N5KbSxAMAub4jFWpS1SXbn603dNyGpdEc/D/xw==
=js84
-----END PGP SIGNATURE-----

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About