If you follow the docs-cvs mailing list you have noticed that I've been
working recently on writing the doc on writing tests. The problem is
that I cannot decide where the documents should go:
On one side we need to have inlined docs of the functions so one can
easily lookup needed features via 'perldoc modulename'. This is a
reference mode.
On the other side, we want to produce a sequential document where one
can learn things by reading a structured document. This is a tutorial mode.
I really want to try to avoid to duplicate documentation. As you realize
that it's a nightmare to maintain.
What do you think is the best approach we should use?
So far I've documented Apache::TestUtil inline and started to document
Apache::Test as an external doc, which is a part of a bigger doc.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:[EMAIL PROTECTED] http://apachetoday.com http://eXtropia.com/
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
