]> git.vpit.fr Git - perl/modules/Perl-Critic-Policy-Dynamic-NoIndirect.git/commitdiff
Document the violations report order
authorVincent Pit <vince@profvince.com>
Tue, 14 Jul 2009 19:45:15 +0000 (21:45 +0200)
committerVincent Pit <vince@profvince.com>
Tue, 14 Jul 2009 19:45:15 +0000 (21:45 +0200)
lib/Perl/Critic/Policy/Dynamic/NoIndirect.pm

index 556ecc6013c209778fce30672b363fd3b85682a0..411da99dee0bc53e9dcc15e0cc0127f7d19694a1 100644 (file)
@@ -121,6 +121,8 @@ The uses of the L<indirect> pragma inside the auditted code take precedence over
 Hence no violations will be reported for indirect method calls that are located inside the lexical scope of C<use indirect> or C<< no indirect hook => ... >>.
 Occurrences of C<no indirect> won't be a problem.
 
+Since the reports generated by L<indirect> are remapped to the corresponding L<PPI::Element> objects, the order in which the violations are returned is different from the order given by L<indirect> : the former is the document order (top to bottom, left to right) while the latter is the optree order (arguments before function calls).
+
 =head1 DEPENDENCIES
 
 L<perl> 5.8, L<Carp>.