This is 0.04

[perl/modules/Perl-Critic-Policy-Dynamic-NoIndirect.git] / README

diff --git a/README b/README
index 86417b877a7b469094c788517937b4b6ddd09568..81143158bd691e500cf27f758b88cdc2b3254a24 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ NAME
     indirect method calls.
 
 VERSION
-    Version 0.03
+    Version 0.04
 
 DESCRIPTION
     This Perl::Critic dynamic policy reports any use of indirect object
@@ -13,6 +13,19 @@ DESCRIPTION
     Since it wraps around indirect, it needs to compile the audited code and
     as such is implemented as a subclass of Perl::Critic::DynamicPolicy.
 
+CAVEATS
+    The uses of the indirect pragma inside the auditted code take precedence
+    over this policy. Hence no violations will be reported for indirect
+    method calls that are located inside the lexical scope of "use indirect"
+    or "no indirect hook => ...". Occurrences of "no indirect" won't be a
+    problem.
+
+    Since the reports generated by indirect are remapped to the
+    corresponding PPI::Element objects, the order in which the violations
+    are returned is different from the order given by indirect : the former
+    is the document order (top to bottom, left to right) while the latter is
+    the optree order (arguments before function calls).
+
 DEPENDENCIES
     perl 5.8, Carp.