|o||You wanted markup it should be a plain paragraph not a verbatim indented one. An =over can be used for indentation if desired.|
|o||You wanted verbatim replace the markup with an ascii approximation like func() or perhaps *bold* or _underline_.|
And this was I<meant> to be plain text. # bad
The check for markup is unsophisticated. Any of the POD specified I< C< etc is taken to be markup, plus J< of Pod::MultiLang.
I< # bad B< # bad C< # bad L< # bad E< # bad F< # bad S< # bad X< # bad Z< # bad J< # bad, for Pod::MultiLang
Its possible a < might be something mathematical like X<Y, but in practice spaces X < Y or lower case letters are more common and are ok.
If a verbatim paragraph is showing how to write POD markup then you can add an =for to tell ProhibitVerbatimMarkup to allow it. This happens most often in documentation for modules which themselves operate on POD markup.
=for ProhibitVerbatimMarkup allow next blah blah E<gt> etc =for ProhibitVerbatimMarkup allow next 2 Two verbatims of C<code> or B<bold> etc
The usual no critic works too,
## no critic (ProhibitVerbatimMarkup)
Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup, Perl::Critic::Policy::Documentation::RequireEndBeforeLastPod
Copyright 2010, 2011, 2012, 2013, 2014, 2015 Kevin Ryde
Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.
|perl v5.20.3||PERL::CRITIC::POLICY::DOCUMENTATION::PROHIBITVERBATIMMARKUP (3)||2015-01-04|