develooper Front page | perl.perl5.porters | Postings from November 2005

[PATCH] perlpod documentation discrepancy in 5.8.6 ( and maybe later? )

Thread Next
From:
demerphq
Date:
November 25, 2005 04:57
Subject:
[PATCH] perlpod documentation discrepancy in 5.8.6 ( and maybe later? )
Message ID:
9b18b3110511250457k6c196c4fu167badd045c2d9e6@mail.gmail.com
Hi,

perlpod.pod omits the new =encoding directive from its "currently
supported directive list".

I also took the liberty of putting =pod at the top of the list, and
=cut at the bottom, which IMO emphasizes their role as beginning an
ending a stream of directives. The other related directives are in a
similar order, such as =over, =item, =back, so it seemed to make
sense.

I contemplated seperating =cut from the rest by a blank line because
of its special behaviour in contrast to the rest. (All of the others
can be used to begin a pod section.) But didnt in this patch.

This patch is against the perlpod in the 5.8.6 release, apologies is
this is already done in 5.8.7 or blead.

Cheers,
Yves

Patch attached as well as inlined...

--- perlpod.pod.bak	2004-12-13 08:50:00.000000000 +0100
+++ perlpod.pod	2005-11-25 13:50:03.691875000 +0100
@@ -60,6 +60,7 @@
 the command can use however it pleases.  Currently recognized commands
 are

+    =pod
     =head1 Heading Text
     =head2 Heading Text
     =head3 Heading Text
@@ -67,11 +68,11 @@
     =over indentlevel
     =item stuff
     =back
-    =cut
-    =pod
     =begin format
     =end format
     =for format text...
+    =encoding type
+    =cut

 To explain them each in detail:




--
perl -Mre=debug -e "/just|another|perl|hacker/"

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About