diff options
author | Karl Williamson <khw@cpan.org> | 2015-04-04 11:57:34 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2015-04-04 12:04:19 -0600 |
commit | 1bca558f18a99576886aa54a63386d1d4ce6f1f7 (patch) | |
tree | f8ae03be06e9aa485701805bb3c3946ef1c7a6d4 /pod/perlpodspec.pod | |
parent | 4d2ca8b5c9aea7369aec591dabed8f7f35f61ce3 (diff) | |
download | perl-1bca558f18a99576886aa54a63386d1d4ce6f1f7.tar.gz |
perlpodspec: Nits
Some of these weren't displaying correctly.
Diffstat (limited to 'pod/perlpodspec.pod')
-rw-r--r-- | pod/perlpodspec.pod | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/pod/perlpodspec.pod b/pod/perlpodspec.pod index c3d172f4d1..36a655b79f 100644 --- a/pod/perlpodspec.pod +++ b/pod/perlpodspec.pod @@ -70,7 +70,7 @@ else with the Pod (like counting words, scanning for index points, etc.). Pod content is contained in B<Pod blocks>. A Pod block starts with a -line that matches <m/\A=[a-zA-Z]/>, and continues up to the next line +line that matches C<m/\A=[a-zA-Z]/>, and continues up to the next line that matches C<m/\A=cut/> or up to the end of the file if there is no C<m/\A=cut/> line. @@ -416,7 +416,7 @@ formatting code. Examples: B<< $foo->bar(); >> With this syntax, the whitespace character(s) after the "CE<lt><<" -and before the ">>" (or whatever letter) are I<not> renderable. They +and before the ">>>" (or whatever letter) are I<not> renderable. They do not signify whitespace, are merely part of the formatting codes themselves. That is, these are all synonymous: @@ -902,17 +902,17 @@ character 34 (doublequote, "), "EE<lt>amp>" for character 38 =item * -Note that in all cases of "EE<lt>whatever>", I<whatever> (whether +Note that in all cases of "EE<lt>whateverE<gt>", I<whatever> (whether an htmlname, or a number in any base) must consist only of alphanumeric characters -- that is, I<whatever> must watch -C<m/\A\w+\z/>. So "EE<lt> 0 1 2 3 >" is invalid, because +C<m/\A\w+\z/>. So S<"EE<lt> 0 1 2 3 E<gt>"> is invalid, because it contains spaces, which aren't alphanumeric characters. This presumably does not I<need> special treatment by a Pod processor; -" 0 1 2 3 " doesn't look like a number in any base, so it would +S<" 0 1 2 3 "> doesn't look like a number in any base, so it would presumably be looked up in the table of HTML-like names. Since -there isn't (and cannot be) an HTML-like entity called " 0 1 2 3 ", +there isn't (and cannot be) an HTML-like entity called S<" 0 1 2 3 ">, this will be treated as an error. However, Pod processors may -treat "EE<lt> 0 1 2 3 >" or "EE<lt>e-acute>" as I<syntactically> +treat S<"EE<lt> 0 1 2 3 E<gt>"> or "EE<lt>e-acute>" as I<syntactically> invalid, potentially earning a different error message than the error message (or warning, or event) generated by a merely unknown (but theoretically valid) htmlname, as in "EE<lt>qacute>" @@ -1136,7 +1136,7 @@ four attributes: =item First: -The link-text. If there is none, this must be undef. (E.g., in +The link-text. If there is none, this must be C<undef>. (E.g., in "LE<lt>Perl Functions|perlfunc>", the link-text is "Perl Functions". In "LE<lt>Time::HiRes>" and even "LE<lt>|Time::HiRes>", there is no link text. Note that link text may contain formatting.) @@ -1149,13 +1149,13 @@ text, then this is the text that we'll infer in its place. (E.g., for =item Third: -The name or URL, or undef if none. (E.g., in "LE<lt>Perl +The name or URL, or C<undef> if none. (E.g., in "LE<lt>Perl Functions|perlfunc>", the name (also sometimes called the page) -is "perlfunc". In "LE<lt>/CAVEATS>", the name is undef.) +is "perlfunc". In "LE<lt>/CAVEATS>", the name is C<undef>.) =item Fourth: -The section (AKA "item" in older perlpods), or undef if none. E.g., +The section (AKA "item" in older perlpods), or C<undef> if none. E.g., in "LE<lt>Getopt::Std/DESCRIPTIONE<gt>", "DESCRIPTION" is the section. (Note that this is not the same as a manpage section like the "5" in "man 5 crontab". "Section Foo" in the Pod sense means the part of the text |