From: Vincent Pit <vince@profvince.com>
Date: Tue, 14 Jul 2009 19:45:15 +0000 (+0200)
Subject: Document the violations report order
X-Git-Tag: v0.04~1
X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FPerl-Critic-Policy-Dynamic-NoIndirect.git;a=commitdiff_plain;h=03dc7499c344c785170db4d4e8452a9eb8e03a1c

Document the violations report order
---

diff --git a/lib/Perl/Critic/Policy/Dynamic/NoIndirect.pm b/lib/Perl/Critic/Policy/Dynamic/NoIndirect.pm
index 556ecc6..411da99 100644
--- a/lib/Perl/Critic/Policy/Dynamic/NoIndirect.pm
+++ b/lib/Perl/Critic/Policy/Dynamic/NoIndirect.pm
@@ -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>.