On Sun, 17 Jul 2011 09:43:01 -0700
Jeffrey Kegler <jeffreykeg...@mac.com> wrote:

> 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.
> 
> Marpa::XS, my XS version of Marpa is now nearing completion.  marpa.pdf, the
> file that contains the internals documentation is 3M -- 3 times the size of
> the rest of the distribution, including marpa.pdf's own sources.  marpa.pdf
> is not necessary as user documentation, but it is essential for
> understanding the internals.  Disk is fairly cheap, and I'd like to upload
> the PDF with the distribution.

Since this will inflate the size of the distribution so much, I would suggest
keeping it out, putting it on a web-site somewhere and giving a link to it from
the POD using the L<http://.../> tag.

Disk may be cheap, but it is multiplied by the number of mirrors as well as
mirroring bandwidth and download times.

Regards,

        Shlomi Fish

-- 
-----------------------------------------------------------------
Shlomi Fish       http://www.shlomifish.org/
Chuck Norris/etc. Facts - http://www.shlomifish.org/humour/bits/facts/

Chuck Norris is the greatest man in history. He killed all the great men who
could ever pose a competition.

Please reply to list if it's a mailing list post - http://shlom.in/reply .

Reply via email to