Pod problems & fixes
authorHallvard B Furuseth <h.b.furuseth@usit.uio.no>
Mon, 24 Mar 1997 20:31:51 +0000 (21:31 +0100)
committerChip Salzenberg <chip@atlantic.net>
Sat, 22 Mar 1997 03:34:25 +0000 (15:34 +1200)
Files: pod/perldiag.pod
Subject: pod2text expands B<-i>C<.bak> to -i`.bak'.  With a quote in
         the middle, it looks like it should be typed in verbatim.
         `-i.bak' is better.

Files: pod/pod2html.PL
Subject: "mailto:" is case-sensitive in URLs.

Files: lib/Term/Complete.pm lib/subs.pm pod/perlop.pod pod/perlembed.pod
       pod/perlguts.pod
Subject: Missing empty lines

Files: INSTALL pod/perlguts.pod
Subject: change `the section on L<..>' to `L<..>', because pod2*
         inserts the "the section on".

Files: pod/perlmod.pod pod/perlcall.pod
Subject: "perl5.00X" -> "perl5.00X or higher"

Files: pod/perldata.pod pod/perldiag.pod pod/perlpod.pod
Subject: "blank line" -> "empty line" where spaces are not ignored

12 files changed:
INSTALL
lib/Term/Complete.pm
lib/subs.pm
pod/perlcall.pod
pod/perldata.pod
pod/perldiag.pod
pod/perlembed.pod
pod/perlguts.pod
pod/perlmod.pod
pod/perlop.pod
pod/perlpod.pod
pod/pod2html.PL

diff --git a/INSTALL b/INSTALL
index ba786e8..4155add 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -19,8 +19,7 @@ The basic steps to build and install perl5 on a Unix system are:
 
 Each of these is explained in further detail below.
 
-For information on non-Unix systems, see the section on
-L<"Porting information"> below.
+For information on non-Unix systems, see L<"Porting information"> below.
 
 =head1 DESCRIPTION
 
index e3c290a..275aade 100644 (file)
@@ -29,6 +29,7 @@ The following command characters are defined:
 =over 4
 
 =item E<lt>tabE<gt>
+
 Attempts word completion.
 Cannot be changed.
 
index aa4c7e7..512bc9b 100644 (file)
@@ -23,6 +23,7 @@ declarations with C<no vars> or C<no subs>.
 See L<perlmod/Pragmatic Modules> and L<strict/strict subs>.
 
 =cut
+
 require 5.000;
 
 sub import {
index 1ff71fc..8236102 100644 (file)
@@ -388,8 +388,8 @@ When C<Call_fred> is executed it will print
 As control never returns to C<Call_fred>, the C<"back in Call_fred">
 string will not get printed.
 
-To work around this problem, you can either upgrade to Perl 5.002 (or
-later), or use the G_EVAL flag with I<perl_call_*> as shown below
+To work around this problem, you can either upgrade to Perl 5.002 or
+higher, or use the G_EVAL flag with I<perl_call_*> as shown below
 
     void
     Call_fred()
index f0837b3..b69e77e 100644 (file)
@@ -342,7 +342,7 @@ quoted, the type of quotes you use determines the treatment of the
 text, just as in regular quoting.  An unquoted identifier works like
 double quotes.  There must be no space between the C<E<lt>E<lt>> and
 the identifier.  (If you put a space it will be treated as a null
-identifier, which is valid, and matches the first blank line.)  The
+identifier, which is valid, and matches the first empty line.)  The
 terminating string must appear by itself (unquoted and with no
 surrounding whitespace) on the terminating line.
 
index 05d04bd..cd48335 100644 (file)
@@ -481,7 +481,7 @@ They must have ordinary identifiers as names.
 =item Can't do in-place edit without backup
 
 (F) You're on a system such as MSDOS that gets confused if you try reading
-from a deleted (but still opened) file.  You have to say B<-i>C<.bak>, or some
+from a deleted (but still opened) file.  You have to say C<-i.bak>, or some
 such.
 
 =item Can't do inplace edit: %s E<gt> 14 characters
@@ -2467,7 +2467,7 @@ bad side effects.
 =item Use of bare E<lt>E<lt> to mean E<lt>E<lt>"" is deprecated
 
 (D) You are now encouraged to use the explicitly quoted form if you
-wish to use a blank line as the terminator of the here-document.
+wish to use an empty line as the terminator of the here-document.
 
 =item Use of implicit split to @_ is deprecated
 
index 4b88754..7752156 100644 (file)
@@ -753,7 +753,7 @@ with L<perlfunc/my> whenever possible.
      exit(exitstatus);
  }
 
+
 Now compile:
 
  % cc -o persistent persistent.c `perl -MExtUtils::Embed -e ccopts -e ldopts` 
index 866cafb..ff3d6cd 100644 (file)
@@ -162,7 +162,7 @@ bus error, or just weird results.  Change the zero to C<&sv_undef> in the first
 line and all will be well.
 
 To free an SV that you've created, call C<SvREFCNT_dec(SV*)>.  Normally this
-call is not necessary (see the section on L<Reference Counts and Mortality>).
+call is not necessary (see L<Reference Counts and Mortality>).
 
 =head2 What's Really Stored in an SV?
 
@@ -422,7 +422,7 @@ A reference can be blessed into a package with the following function:
     SV* sv_bless(SV* sv, HV* stash);
 
 The C<sv> argument must be a reference.  The C<stash> argument specifies
-which class the reference will belong to.  See the section on 
+which class the reference will belong to.  See
 L<Stashes and Globs> for information on converting class names into stashes.
 
 /* Still under construction */
@@ -1587,7 +1587,7 @@ C<hv_iterinit>.
        char*   hv_iterkey _((HE* entry, I32* retlen));
 
 =item hv_iterkeysv
-       
+
 Returns the key as an C<SV*> from the current position of the hash
 iterator.  The return value will always be a mortal copy of the
 key.  Also see C<hv_iterinit>.
index 2f1ae5b..194cd11 100644 (file)
@@ -1428,6 +1428,6 @@ the application could invoked as:
 
      perl -e 'use Module::Name; method(@ARGV)' ...
 or
-     perl -mModule::Name ...    (in perl5.002)
+     perl -mModule::Name ...    (in perl5.002 or higher)
 
 =back
index c4a342b..a075667 100644 (file)
@@ -741,10 +741,10 @@ combine several regexps like this to process a string part-by-part,
 doing different actions depending on which regexp matched.  The next
 regexp would step in at the place the previous one left off.
 
   $_ = <<'EOL';
+ $_ = <<'EOL';
       $url = new URI::URL "http://www/";   die if $url eq "xXx";
-EOL
 LOOP:
+ EOL
+ LOOP:
     {
       print(" digits"),                redo LOOP if /\G\d+\b[,.;]?\s*/g;
       print(" lowercase"),     redo LOOP if /\G[a-z]+\b[,.;]?\s*/g;
index ce09221..6a13991 100644 (file)
@@ -95,7 +95,7 @@ treat some of these as synonyms.)
 
 And don't forget, when using any command, that the command lasts up until
 the end of the B<paragraph>, not the line. Hence in the examples below, you
-can see the blank lines after each command to end its paragraph.
+can see the empty lines after each command to end its paragraph.
 
 Some examples of lists include:
 
@@ -188,7 +188,7 @@ documentation with a "=head1" command at the beginning, and end it
 with a "=cut" command.  Perl will ignore the pod text.  See any of the
 supplied library modules for examples.  If you're going to put your
 pods at the end of the file, and you're using an __END__ or __DATA__
-cut mark, make sure to put a blank line there before the first pod
+cut mark, make sure to put an empty line there before the first pod
 directive.
 
     __END__
@@ -198,7 +198,7 @@ directive.
 
     modern - I am a modern module
 
-If you had not had that blank line there, then the translators wouldn't
+If you had not had that empty line there, then the translators wouldn't
 have seen it.
 
 =head1 Common Pod Pitfalls
@@ -208,7 +208,7 @@ have seen it.
 =item *
 
 Pod translators usually will require paragraphs to be separated by
-completely empty lines.  If you have an apparently blank line with
+completely empty lines.  If you have an apparently empty line with
 some spaces on it, this can cause odd formatting.
 
 =item *
@@ -222,7 +222,7 @@ sensibly.
 =item *
 
 The script F<pod/checkpods.PL> in the Perl source distribution
-provides skeletal checking for lines that look blank but aren't
+provides skeletal checking for lines that look empty but aren't
 B<only>, but is there as a placeholder until someone writes
 Pod::Checker.  The best way to check your pod is to pass it through
 one or more translators and proofread the result, or print out the
index 8dafea5..1c53f6c 100644 (file)
@@ -526,7 +526,7 @@ sub find_refs {
     for ($$thing) {
        #s:L<([a-zA-Z][^\s\/]+)(\([^\)]+\))>:the I<$1>$2 manpage:g;
         s@(\S+?://\S*[^.,;!?\s])@noremap(qq{<A HREF="$1">$1</A>})@ge;
-        s,([a-z0-9_.-]+\@([a-z0-9_-]+\.)+([a-z0-9_-]+)),noremap(qq{<A HREF="MAILTO:$1">$1</A>}),gie;
+        s,([a-z0-9_.-]+\@([a-z0-9_-]+\.)+([a-z0-9_-]+)),noremap(qq{<A HREF="mailto:$1">$1</A>}),gie;
        s/L<([^>]*)>/lrefs($1,$htype)/ge;
        s/([CIBF])<(\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge;
        s/(S)<([^\/]\W*?(-?\w*).*?)>/picrefs($1, $2, $3, $htype)/ge;