Front page | perl.perl5.porters |
Postings from April 2010
On Fri, 02 Apr 2010 19:55:10 +0300, Jari Aalto <jari.aalto@cante.net>
wrote:
> I noticed that many of the manual pages are inconsistent with the
> perlstyle.pod guidelines. While this may seem like a minor quibble, I
> personally think the quality of documentation is visible from the
> writing and 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.
NOT OK:
3. &&,|| => and, or
read the thread to note the pitfalls
4. remove parens
too much disagreeing
--
H.Merijn Brand http://tux.nl Perl Monger http://amsterdam.pm.org/
using & porting perl 5.6.2, 5.8.x, 5.10.x, 5.11.x on HP-UX 10.20, 11.00,
11.11, 11.23, and 11.31, OpenSuSE 10.3, 11.0, and 11.1, AIX 5.2 and 5.3.
http://mirrors.develooper.com/hpux/ http://www.test-smoke.org/
http://qa.perl.org http://www.goldmark.org/jeff/stupid-disclaimers/
Thread Previous
|
Thread Next