Change 21349: The FAQ answer about POD comments was incorrect. [perl #23893]

[email protected] (Rafael Garcia-Suarez)
Newsgroups perl.perlfaq.workers,perl.perl5.changes
Message-ID <[email protected]>
Change 21349 by rgs@rgs-home on 2003/09/23 22:09:57

	The FAQ answer about POD comments was incorrect. [perl #23893]
	(plus a few typos.)

Affected files ...

... //depot/perl/pod/perlfaq7.pod#39 edit
... //depot/perl/pod/perlpodspec.pod#10 edit

Differences ...

==== //depot/perl/pod/perlfaq7.pod#39 (text) ====
Index: perl/pod/perlfaq7.pod
--- perl/pod/perlfaq7.pod#38~20330~	Tue Jul 29 14:20:28 2003
+++ perl/pod/perlfaq7.pod	Tue Sep 23 15:09:57 2003
@@ -725,32 +725,27 @@
 
 =head2 How can I comment out a large block of perl code?
 
-You can use embedded POD to discard it.  The =for directive
-lasts until the next paragraph (two consecutive newlines).
+You can use embedded POD to discard it.  Enclose the blocks you want
+to comment out in POD markers, for example C<=for nobody> and C<=cut>
+(which marks ends of POD blocks).
 
     # program is here
 
     =for nobody
-    This paragraph is commented out
-
-    # program continues
-
-The =begin and =end directives can contain multiple
-paragraphs.
-
-    =begin comment text
 
     all of this stuff
 
     here will be ignored
     by everyone
 
-    =end comment text
+    =cut
+
+    # program continues
 
 The pod directives cannot go just anywhere.  You must put a
 pod directive where the parser is expecting a new statement,
 not just in the middle of an expression or some other
-arbitrary s grammar production.
+arbitrary grammar production.
 
 See L<perlpod> for more details.
 

==== //depot/perl/pod/perlpodspec.pod#10 (text) ====
Index: perl/pod/perlpodspec.pod
--- perl/pod/perlpodspec.pod#9~21198~	Fri Sep 12 10:59:25 2003
+++ perl/pod/perlpodspec.pod	Tue Sep 23 15:09:57 2003
@@ -238,7 +238,7 @@
   # This is the first line of program text.
   sub foo { # This is the second.
 
-It is an error to try to I<start> a Pod black with a "=cut" command.  In
+It is an error to try to I<start> a Pod block with a "=cut" command.  In
 that case, the Pod processor must halt parsing of the input file, and
 must by default emit a warning.
 
End of Patch.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.