Skip to content

Commit

Permalink
perlpodspec: Note t that "=item *" has nothing else
Browse files Browse the repository at this point in the history
=item * foo bar

is not supposed to be a bullet list; it is a text (definition) list
whose first character is an asterisk.

This is implied later on in the existing documentation where it says
that

 The "=item [text]" paragraph should not match
 C<m/\A=item\s+\d+\.?\s*\z/> or C<m/\A=item\s+\*\s*\z/>, nor should it
 match just C<m/\A=item\s*\z/>.

The text already says numbered lists must match
<m/\A=item\s+\d+\.?\s*\z/.  This commit adapts that text to the bullet
list case.
  • Loading branch information
khwilliamson committed Nov 20, 2024
1 parent 080baaf commit f00bc6c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions pod/perlpodspec.pod
Original file line number Diff line number Diff line change
Expand Up @@ -1425,9 +1425,9 @@ Each "=over" ... "=back" region should be one of the following:

=item *

An "=over" ... "=back" region containing only "=item *" commands,
each followed by some number of ordinary/verbatim paragraphs, other
nested "=over" ... "=back" regions, "=for..." paragraphs, and
An "=over" ... "=back" region containing only C<m/\A=item\s+\*\s*\z/>
commands, each followed by some number of ordinary/verbatim paragraphs,
other nested "=over" ... "=back" regions, "=for..." paragraphs, and
"=begin"..."=end" regions.

(Pod processors must tolerate a bare "=item" as if it were "=item
Expand Down

0 comments on commit f00bc6c

Please sign in to comment.