Front page | perl.perl5.porters |
Postings from April 2010
On Sat, Apr 03, 2010 at 09:18:37PM +0300, Jari Aalto wrote: > "H.Merijn Brand" <h.m.brand@xs4all.nl> writes: > > >> adhering to the style conventions. > > > > Conclusions from this threa[dt] so far: > > > > OK: > > > > 1. Add spaces after comma in argument lists: > > > > open(FOO,$foo) => open(FOO, $foo) > > > > 2. Make indentation consistent > > > > I suggest using 2-space indent everywhere, as otherwise pod will > > have render trouble with longer lines if you would use the wider > > accepted 4-space indent. > > >From perldoc perlstyle.pod: > > 4-column indent. For code, yes. Problem with POD documentation is that code is already indented to start with, leaving you far less than 80 columns to work with. I often cut-and-paste code with 4-column indent into *POD*, and then have to change the indentation to 2-columns to keep the code with 80 characters after pod2man | nroff -man. Documentation where code wraps to the next line on the screen is quite hard to read. AbigailThread Previous | Thread Next