Re: constant function inlining
[p5sagit/p5-mst-13.2.git] / pod / perlstyle.pod
index e4a5aab..734b9ad 100644 (file)
@@ -12,7 +12,7 @@ The most important thing is to run your programs under the B<-w>
 flag at all times.  You may turn it off explicitly for particular
 portions of code via the C<$^W> variable if you must.  You should
 also always run under C<use strict> or know the reason why not.
-The <use sigtrap> and even <use diagnostics> pragmas may also prove
+The C<use sigtrap> and even C<use diagnostics> pragmas may also prove
 useful.
 
 Regarding aesthetics of code lay out, about the only thing Larry
@@ -32,7 +32,7 @@ Opening curly on same line as keyword, if possible, otherwise line up.
 
 =item *
 
-Space before the opening curly of a multiline BLOCK.
+Space before the opening curly of a multi-line BLOCK.
 
 =item *
 
@@ -64,7 +64,7 @@ Uncuddled elses.
 
 =item *
 
-No space between function name and its opening paren.
+No space between function name and its opening parenthesis.
 
 =item *
 
@@ -76,7 +76,7 @@ Long lines broken after an operator (except "and" and "or").
 
 =item *
 
-Space after last paren matching on current line.
+Space after last parenthesis matching on current line.
 
 =item *
 
@@ -88,7 +88,7 @@ Omit redundant punctuation as long as clarity doesn't suffer.
 
 =back
 
-Larry has his reasons for each of these things, but he doen't claim that
+Larry has his reasons for each of these things, but he doesn't claim that
 everyone else's mind works the same as his does.
 
 Here are some other more substantive style issues to think about:
@@ -117,7 +117,7 @@ is better than
 
     $verbose && print "Starting analysis\n";
 
-since the main point isn't whether the user typed B<-v> or not.
+because the main point isn't whether the user typed B<-v> or not.
 
 Similarly, just because an operator lets you assume default arguments
 doesn't mean that you have to make use of the defaults.  The defaults
@@ -135,7 +135,7 @@ schmuck bounce on the % key in B<vi>.
 
 Even if you aren't in doubt, consider the mental welfare of the person
 who has to maintain the code after you, and who will probably put
-parens in the wrong place.
+parentheses in the wrong place.
 
 =item *
 
@@ -169,7 +169,7 @@ the system() function instead.
 For portability, when using features that may not be implemented on
 every machine, test the construct in an eval to see if it fails.  If
 you know what version or patchlevel a particular feature was
-implemented, you can test C<$]> ($PERL_VERSION in C<English>) to see if it
+implemented, you can test C<$]> (C<$PERL_VERSION> in C<English>) to see if it
 will be there.  The C<Config> module will also let you interrogate values
 determined by the B<Configure> program when Perl was installed.
 
@@ -189,7 +189,7 @@ Package names are sometimes an exception to this rule.  Perl informally
 reserves lowercase module names for "pragma" modules like C<integer> and
 C<strict>.  Other modules should begin with a capital letter and use mixed
 case, but probably without underscores due to limitations in primitive
-filesystems' representations of module names as files that must fit into a
+file systems' representations of module names as files that must fit into a
 few sparse bites.
 
 =item *
@@ -202,7 +202,7 @@ or nature of a variable. For example:
     $no_caps_here    function scope my() or local() variables 
 
 Function and method names seem to work best as all lowercase. 
-E.g., $obj->as_string(). 
+E.g., $obj-E<gt>as_string(). 
 
 You can use a leading underscore to indicate that a variable or
 function should not be used outside the package that defined it.
@@ -216,9 +216,9 @@ Don't use slash as a delimiter when your regexp has slashes or backslashes.
 =item *
 
 Use the new "and" and "or" operators to avoid having to parenthesize
-list operators so much, and to reduce the incidence of punctuational
+list operators so much, and to reduce the incidence of punctuation
 operators like C<&&> and C<||>.  Call your subroutines as if they were
-functions or list operators to avoid excessive ampersands and parens.
+functions or list operators to avoid excessive ampersands and parentheses.
 
 =item *