summaryrefslogtreecommitdiff
path: root/pod/perlpodspec.pod
diff options
context:
space:
mode:
authorRicardo Signes <rjbs@cpan.org>2009-12-07 18:24:59 -0500
committerRafael Garcia-Suarez <rgs@consttype.org>2009-12-08 10:59:49 +0100
commit93592fd5aeec89ac25994a493ef54e1d7a572d65 (patch)
tree4c5c36a284f5594480fc8bf8645b326013542734 /pod/perlpodspec.pod
parentb41aadf259cf55858c5ab0386356cdbe2dc49a6b (diff)
downloadperl-93592fd5aeec89ac25994a493ef54e1d7a572d65.tar.gz
legalize =begin foo bar
Diffstat (limited to 'pod/perlpodspec.pod')
-rw-r--r--pod/perlpodspec.pod10
1 files changed, 7 insertions, 3 deletions
diff --git a/pod/perlpodspec.pod b/pod/perlpodspec.pod
index 761b1bbea6..7ab56598ae 100644
--- a/pod/perlpodspec.pod
+++ b/pod/perlpodspec.pod
@@ -293,6 +293,8 @@ by the most recent "=over" command. It permits no text after the
=item "=begin formatname"
+=item "=begin formatname parameter"
+
This marks the following paragraphs (until the matching "=end
formatname") as being for some special kind of processing. Unless
"formatname" begins with a colon, the contained non-command
@@ -302,9 +304,11 @@ or data paragraphs. This is discussed in detail in the section
L</About Data Paragraphs and "=beginE<sol>=end" Regions>.
It is advised that formatnames match the regexp
-C<m/\A:?[-a-zA-Z0-9_]+\z/>. Implementors should anticipate future
-expansion in the semantics and syntax of the first parameter
-to "=begin"/"=end"/"=for".
+C<m/\A:?[−a−zA−Z0−9_]+\z/>. Everything following whitespace after the
+formatname is a parameter that may be used by the formatter when dealing
+with this region. This parameter must not be repeated in the "=end"
+paragraph. Implementors should anticipate future expansion in the
+semantics and syntax of the first parameter to "=begin"/"=end"/"=for".
=item "=end formatname"