.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup 3pm" .TH Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup 3pm "2021-02-28" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup \- unexpanded C<> etc markup in POD verbatim paras .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It reports \s-1POD\s0 verbatim paragraphs which contain markup like B<> or C<>. That markup will appear literally in the formatted output where you may have meant fontification. .PP .Vb 1 \& =head1 SOME THING \& \& Paragraph of text introducing an example, \& \& # call the C function # bad \& &foo(); .Ve .PP This is purely cosmetic so this policy is low severity and under the \&\*(L"cosmetic\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). Normally it means one of two things, .IP "\(bu" 4 You want markup \*(-- it should be a plain paragraph not a verbatim indented one. An \f(CW\*(C`=over\*(C'\fR can be used for indentation if desired. .IP "\(bu" 4 You want verbatim \*(-- replace the markup with an ascii approximation like \&\f(CW\*(C`func()\*(C'\fR or perhaps \f(CW\*(C`*bold*\*(C'\fR or \f(CW\*(C`_underline_\*(C'\fR. .PP Don't forget that a verbatim paragraph extends to the next blank line and includes unindented lines until then too (see \*(L"Pod Definitions\*(R" in perlpodspec). If you forget the blank line then the verbatimness continues .PP .Vb 1 \& =pod \& \& $some\->sample; \& code(); \& And this was I to be plain text. # bad .Ve .SS "Markup Forms" .IX Subsection "Markup Forms" The check for markup is unsophisticated. Any of the \s-1POD\s0 specified \*(L"I<\*(R" \&\*(L"C<\*(R" etc is taken to be markup, plus \*(L"J<\*(R" of \f(CW\*(C`Pod::MultiLang\*(C'\fR. .PP .Vb 10 \& I< # bad \& B< # bad \& C< # bad \& L< # bad \& E< # bad \& F< # bad \& S< # bad \& X< # bad \& Z< # bad \& J< # bad, for Pod::MultiLang .Ve .PP It's possible a \f(CW\*(C`<\*(C'\fR might be something mathematical like \*(L"X\*(C'\fR style sample Perl debugger output is exempted (see perldebug). It's uncommon, but not likely to have intended \&\f(CW\*(C`B<>\*(C'\fR bold. .PP .Vb 1 \& DB<123> dump b # ok .Ve .SS "Disabling" .IX Subsection "Disabling" If a verbatim paragraph is showing how to write \s-1POD\s0 markup then you can add an \f(CW\*(C`=for\*(C'\fR to tell \f(CW\*(C`ProhibitVerbatimMarkup\*(C'\fR to allow it. This happens most often in documentation for modules which themselves operate on \s-1POD\s0 markup. .PP .Vb 1 \& =for ProhibitVerbatimMarkup allow next \& \& blah blah E etc \& \& =for ProhibitVerbatimMarkup allow next 2 \& \& Two verbatims of C \& \& or B etc .Ve .PP The usual no critic works too, .PP .Vb 1 \& ## no critic (ProhibitVerbatimMarkup) .Ve .PP But the annotation must be before any \f(CW\*(C`_\|_END_\|_\*(C'\fR token, and if the \s-1POD\s0 is after an \f(CW\*(C`_\|_END_\|_\*(C'\fR token then \f(CW\*(C`Perl::Critic\*(C'\fR 1.112 up is required. An \&\f(CW\*(C`=for\*(C'\fR has the advantage of being together with the exception. .PP As always if you don't care at all about this at all then disable \&\f(CW\*(C`ProhibitVerbatimMarkup\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Documentation::ProhibitVerbatimMarkup] .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic, Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup, Perl::Critic::Policy::Documentation::RequireEndBeforeLastPod .SH "HOME PAGE" .IX Header "HOME PAGE" http://user42.tuxfamily.org/perl\-critic\-pulp/index.html .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde .PP Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Perl-Critic-Pulp is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Perl-Critic-Pulp. If not, see .