On Mon, Jul 18, 2011 at 2:07 PM, Andreas J. Koenig < andreas.koenig.7os6v...@franz.ak.mind.de> wrote:
> >>>>> On Sun, 17 Jul 2011 09:43:01 -0700, Jeffrey Kegler < > jeffreykeg...@mac.com> said: > > > I'd like feedback on a question. My feeling is that internals > documentation is > > important, that disk is relatively cheap, and that I should include the > PDF > > file that contains Marpa's internal documentation with the CPAN > distribution. > > But I'd like to know if others agree. > > I have read three opinions for separating documentation and code. I > myself am pretty indifferent, but I'd point out that potentially code > and docs would not need the same update frequency. That would mean that > a separate way of distributing could be taken. > > Why is the documentation in PDF form? If it's documentation for a Perl module, it should be in POD format so that it can be viewed the way all other Perl modules are. If the PDF is not closely linked to the Perl module, then a link in the POD to a Web URL where it can be found for more information seems like the way to go.
