forked from marcgreen/perl-pod-checker
/
pc-errors-todo
103 lines (59 loc) · 2.3 KB
/
pc-errors-todo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
=head2 Errors
=over 4
=back
=head2 Warnings
These may not necessarily cause trouble, but indicate mediocre style.
=over 4
=begin _disabled_
=item * file does not start with =head
The file starts with a different POD directive than head.
This is most probably something you do not want.
=end _disabled_
=back
=head2 Hyperlinks
=over
=back
=head1 IN POD::SIMPLE ALREADY
=head2 Errors
=over
=item * =item without previous =over
=item * =back without previous =over
An C<=item> or C<=back> command has been found outside a
C<=over>/C<=back> block.
=item * No argument for =begin
A C<=begin> command was found that is not followed by the formatter
specification.
=item * =end without =begin
A standalone C<=end> command was found.
=item * =for without formatter specification
There is no specification of the formatter after the C<=for> command.
=item * Unknown command "I<CMD>"
An invalid POD command has been found. Valid are C<=head1>, C<=head2>,
C<=head3>, C<=head4>, C<=over>, C<=item>, C<=back>, C<=begin>, C<=end>,
C<=for>, C<=pod>, C<=cut>
=item * Unknown interior-sequence "I<SEQ>"
An invalid markup command has been encountered. Valid are:
C<BE<lt>E<gt>>, C<CE<lt>E<gt>>, C<EE<lt>E<gt>>, C<FE<lt>E<gt>>,
C<IE<lt>E<gt>>, C<LE<lt>E<gt>>, C<SE<lt>E<gt>>, C<XE<lt>E<gt>>,
C<ZE<lt>E<gt>>
=item * Spurious character(s) after =back
The C<=back> command does not take any arguments.
=item * malformed link LE<lt>E<gt>
The link found cannot be parsed because it does not conform to the
syntax described in L<perlpod>.
NOTE: THE ONLY MALFORMATION IS AN EMPTY L<>, WHICH POD::SIMPLE ALREADY DOES
=item * garbled entity I<STRING>
The I<STRING> found cannot be interpreted as a character entity.
=back
NOTE: THIS IS EMULATED BY 'STRANGE CONTENT' ERROR AND 'UNKNOWN E CONTENT' ERROR
=head2 Warnings (reported as errors in Pod::Simple though, fix this)
=over
=item * preceding non-item paragraph(s)
A list introduced by C<=over> starts with a text or verbatim paragraph,
but continues with C<=item>s. Move the non-item paragraph out of the
C<=over>/C<=back> block.
=item * =item type mismatch (I<one> vs. I<two>)
A list started with e.g. a bullet-like C<=item> and continued with a
numbered one. This is obviously inconsistent. For most translators the
type of the I<first> C<=item> determines the type of the list.
=back