[Dbix-class] Documentation formatting
Matt S Trout
dbix-class at trout.me.uk
Fri Mar 24 22:36:34 CET 2006
Andrew Ford wrote:
> I would still argue for 4 spaces. Personally I find two an indent of
> two spaces difficult to make out in some circumstances -- don't know
> whether it is just my age or eyesight. The Manual/Example.pod has
> extended code samples with just a one character indent, which is
> impossible to discern under Emacs or printed out. The CPAN-style HTML
> formatting does of course make verbatim blocks very evident, but I for
> one tend to view man pages in an Xterm, under Emacs or printed through
> groff and badly formatted man pages are a right pain.
Example.pod is all two now, which seems to be the "usual" standard in POD and
is definitely how the entirety of DBIx::Class is written. I don't think it's
overly illegible and has the advantage of avoiding linebreaks even under
perldoc on an 80x25 xterm (which is what I read everything in :)
--
Matt S Trout Offering custom development, consultancy and support
Technical Director contracts for Catalyst, DBIx::Class and BAST. Contact
Shadowcat Systems Ltd. mst (at) shadowcatsystems.co.uk for more information
+ Help us build a better perl ORM: http://dbix-class.shadowcatsystems.co.uk/ +
More information about the Dbix-class
mailing list