summaryrefslogtreecommitdiff
path: root/pod/perlstyle.pod
diff options
context:
space:
mode:
authorPerl 5 Porters <perl5-porters@africa.nicoh.com>1996-09-20 15:08:33 +0100
committerAndy Dougherty <doughera@lafcol.lafayette.edu>1996-09-20 15:08:33 +0100
commit184e971831b273a4209000a9990327c3ea67e866 (patch)
tree4d6ac6b99c1907585bfe284ff6c2d882fa5db009 /pod/perlstyle.pod
parent9c3bb3dec7e8cf606ffb42be143f70853f7d31a1 (diff)
downloadperl-184e971831b273a4209000a9990327c3ea67e866.tar.gz
perl 5.003_06: pod/perlcall.pod pod/perldata.pod pod/perldebug.pod pod/perlembed.pod pod/perlfunc.pod pod/perlipc.pod pod/perlpod.pod pod/perlref.pod pod/perlstyle.pod pod/perlsyn.pod pod/perltie.pod pod/perlxstut.pod
Date: Wed, 11 Sep 1996 11:55:18 -0500 From: "Daniel S. Lewart" <lewart@vadds.cvm.uiuc.edu> Subject: POD spelling patches Date: Fri, 20 Sep 1996 15:08:33 +0100 (BST) From: "Joseph S. Myers" <jsm28@hermes.cam.ac.uk> Subject: Pod typos, pod2man bugs, and miscellaneous installation comments Here is a patch for various typos and other defects in the Perl 5.003_05 pods, including the pods embedded in library modules.
Diffstat (limited to 'pod/perlstyle.pod')
-rw-r--r--pod/perlstyle.pod8
1 files changed, 4 insertions, 4 deletions
diff --git a/pod/perlstyle.pod b/pod/perlstyle.pod
index e4a5aab41f..46c17ddae3 100644
--- a/pod/perlstyle.pod
+++ b/pod/perlstyle.pod
@@ -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
@@ -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:
@@ -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.
@@ -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.