Make it clear you should use MRO::Compat not this

[gitmo/Class-C3.git] / lib / Class / C3.pm

diff --git a/lib/Class/C3.pm b/lib/Class/C3.pm
index a1fb537..e7c16a0 100644 (file)
--- a/lib/Class/C3.pm
+++ b/lib/Class/C3.pm
@@ -227,6 +227,7 @@ Class::C3 - A pragma to use the C3 method resolution order algortihm
 
 =head1 SYNOPSIS
 
+    # NOTE - DO NOT USE Class::C3 directly as a user, use MRO::Compat instead!
     package A;
     use Class::C3;
     sub hello { 'A::hello' }
@@ -270,6 +271,11 @@ Class::C3 - A pragma to use the C3 method resolution order algortihm
 This is pragma to change Perl 5's standard method resolution order from depth-first left-to-right
 (a.k.a - pre-order) to the more sophisticated C3 method resolution order.
 
+B<NOTE:> YOU SHOULD NOT USE THIS MODULE DIRECTLY - The feature provided
+is integrated into perl version >= 5.9.5, and you should use L<MRO::Compat>
+instead, which will use the core implementation in newer perls, but fallback
+to using this implementation on older perls.
+
 =head2 What is C3?
 
 C3 is the name of an algorithm which aims to provide a sane method resolution order under multiple