.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Perl::Critic::Policy::Documentation::ProhibitDuplicateHeadings 3pm" .TH Perl::Critic::Policy::Documentation::ProhibitDuplicateHeadings 3pm "2018-05-30" "perl v5.26.2" "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::ProhibitDuplicateHeadings \- don't duplicate =head names .SH "DESCRIPTION" .IX Header "DESCRIPTION" This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR add-on. It asks you not to duplicate heading names in \f(CW\*(C`=head\*(C'\fR \s-1POD\s0 commands. .PP .Vb 1 \& =head1 SOMETHING \& \& =head1 SOMETHING # bad, duplicate .Ve .PP Duplication is usually a mistake, perhaps too much cut-and-paste, or a leftover from a template, or perhaps text in two places which ought to be together. On that basis this policy is medium severity and under the \*(L"bugs\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic). .SS "Default Uniqueness" .IX Subsection "Default Uniqueness" The policy default is to demand that a given heading is unique to its ancestors, siblings, and to the immediately adjacent heading irrespective of level. This is designed to be how human readers perceive the scope of headings and subheadings, plus adjacency in case a mixture of heading levels would let a duplicate otherwise go undetected. For example .PP .Vb 1 \& =head1 Top \& \& =head2 Subhead \& \& =head3 Top # bad, duplicates its ancestor head1 .Ve .PP Or siblings .PP .Vb 1 \& =head1 Top \& \& =head2 Down \& \& =head2 Another \& \& =head2 Down # bad, duplicates sibling head2 .Ve .PP Or adjacent .PP .Vb 1 \& =head2 Blah \& \& =head1 Blah # bad, duplicates adjacent .Ve .PP A subheading can be repeated if it's under a different higher heading. For example the following two \*(L"Details\*(R" are cousins, so allowed. .PP .Vb 1 \& =head1 One \& \& =head2 Details \& \& =head1 Two \& \& =head2 Details # ok .Ve .SS "All Unique" .IX Subsection "All Unique" Option \f(CW\*(C`uniqueness=all\*(C'\fR (see \*(L"\s-1CONFIGURATION\*(R"\s0 below) applies a stricter rule so that all \f(CW\*(C`=head\*(C'\fR names must be unique throughout the document, irrespective of levels and structure. .PP .Vb 1 \& =head3 Foo \& \& =head1 Bar \& \& =head3 Foo # bad .Ve .PP One use for this is to ensure all headings can be reached by an \&\f(CW\*(C`L<>\*(C'\fR link. An \f(CW\*(C`L<>\*(C'\fR only has the heading name, no level or path, so if there's any duplication among the names then only the first of each duplicate will be reachable. (The \s-1POD\s0 browsers usually go to the first among duplicates.) .PP This rule is often too strict. It can be good to have similar subheadings like \*(L"Details\*(R" as shown above, with no need to make such sub-parts reachable by a link. .SS "Disabling" .IX Subsection "Disabling" If you don't care at all about this you can disable \&\f(CW\*(C`ProhibitDuplicateHeadings\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see \&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic), .PP .Vb 1 \& [\-Documentation::ProhibitDuplicateHeadings] .Ve .SH "CONFIGURATION" .IX Header "CONFIGURATION" .ie n .IP """uniqueness"" (string, default ""default"")" 4 .el .IP "\f(CWuniqueness\fR (string, default ``default'')" 4 .IX Item "uniqueness (string, default default)" The uniqueness to be enforced on each heading. The value is a comma-separated list of .Sp .Vb 5 \& default currently "ancestor,sibling,adjacent" \& ancestor don\*(Aqt duplicate parent, grandparent, etc \& sibling same level and parent \& adjacent immediately preceding, irrespective of level \& all all headings .Ve .Sp The default is \*(L"default\*(R" and the intention is to have default mean a sensible set of restrictions, though precisely what it might be could change. .Sp For example in your \fI.perlcriticrc\fR file .Sp .Vb 2 \& [Documentation::ProhibitDuplicateHeadings] \& uniqueness=ancestor,adjacent .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" Perl::Critic::Pulp, Perl::Critic .PP Perl::Critic::Policy::Documentation::ProhibitDuplicateSeeAlso, Perl::Critic::Policy::Documentation::RequirePodSections .SH "HOME PAGE" .IX Header "HOME PAGE" http://user42.tuxfamily.org/perl\-critic\-pulp/index.html .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2013, 2014, 2015, 2016, 2017 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 .