From: Michael G Schwern <mschwern@cpan.org>
Date: Fri, 10 Aug 2007 07:54:30 +0000 (-0700)
Subject: Document that we're doing AbstractSearch, too
X-Git-Tag: v0.08240~541^2~53
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=e7d1440fa81ee32af07118f85cd0310e48e14e09;p=dbsrgits%2FDBIx-Class.git

Document that we're doing AbstractSearch, too

Split out the customization recepie a bit.

Document some limitations.
---

diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm
index 5ced100..750b19c 100644
--- a/lib/DBIx/Class/CDBICompat.pm
+++ b/lib/DBIx/Class/CDBICompat.pm
@@ -53,10 +53,11 @@ DBIx::Class::CDBICompat - Class::DBI Compatibility layer.
 =head1 DESCRIPTION
 
 DBIx::Class features a fully featured compatibility layer with L<Class::DBI>
-to ease transition for existing CDBI users. In fact, this class is just a
-receipe containing all the features emulated. If you like, you can choose
-which features to emulate by building your own class and loading it like
-this:
+and L<Class::DBI::AbstractSearch> to ease transition for existing CDBI users. 
+
+In fact, this class is just a receipe containing all the features emulated.
+If you like, you can choose which features to emulate by building your 
+own class and loading it like this:
 
   __PACKAGE__->load_own_components(qw/CDBICompat/);
 
@@ -131,6 +132,30 @@ in the perl interpreter.
 
 =back
 
+=head1 LIMITATIONS
+
+The following methods and classes are not emulated, maybe in the future.
+
+=over 4
+
+=item Class::DBI::Query
+
+Deprecated in Class::DBI.
+
+=item Class::DBI::Column
+
+Not documented in Class::DBI.  CDBICompat's columns() returns a plain string, not an object.
+
+=item data_type()
+
+Undocumented CDBI method.
+
+=item meta_info()
+
+Undocumented CDBI method.
+
+=back
+
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>