From: Daniel Westermann-Clark <danieltwc@cpan.org>
Date: Sat, 21 Jan 2006 19:18:44 +0000 (+0000)
Subject: - Add synopsis
X-Git-Tag: v0.05005~117^2~24
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=662e8798a79b7d8f8f2dbb3d1f14b664883710e6;p=dbsrgits%2FDBIx-Class.git

- Add synopsis
- Table -> TableInstance in POD
- Add note about loading a PK::Auto component
---

diff --git a/lib/DBIx/Class/Core.pm b/lib/DBIx/Class/Core.pm
index 9cb474e..298192b 100644
--- a/lib/DBIx/Class/Core.pm
+++ b/lib/DBIx/Class/Core.pm
@@ -19,15 +19,19 @@ __PACKAGE__->load_components(qw/
 
 =head1 NAME 
 
-DBIx::Class::Core - Core set of DBIx::Class modules.
+DBIx::Class::Core - Core set of DBIx::Class modules
+
+=head1 SYNOPSIS
+
+  # In your table classes
+  __PACKAGE__->load_components(qw/Core/);
 
 =head1 DESCRIPTION
 
-This class just inherits from the various modules that makes 
-up the DBIx::Class core features. This makes it a convenient base
-class for your DBIx::Class setup.
+This class just inherits from the various modules that make up the
+L<DBIx::Class> core features.  You almost certainly want these.
 
-At the moment those are:
+The core modules currently are:
 
 =over 4
 
@@ -39,7 +43,7 @@ At the moment those are:
 
 =item L<DBIx::Class::Row>
 
-=item L<DBIx::Class::Table>
+=item L<DBIx::Class::TableInstance>
 
 =item L<DBIx::Class::Exception>
 
@@ -47,6 +51,10 @@ At the moment those are:
 
 =back
 
+If you are also using a L<DBIx::Class::PK::Auto> component, please
+make sure you load it correctly. Refer to
+L<DBIx::Class::PK::Auto/DESCRIPTION> for more information.
+
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>
@@ -56,4 +64,3 @@ Matt S. Trout <mst@shadowcatsystems.co.uk>
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-