more dob updates

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / PK.pm

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index eb15f32..eb2540d 100644 (file)
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -16,8 +16,8 @@ DBIx::Class::PK - Primary Key class
 
 =head1 DESCRIPTION
 
-This class represents methods handling primary keys
-and depending on them.
+This class contains methods for handling primary keys and methods 
+depending on them.
 
 =head1 METHODS
 
@@ -33,9 +33,10 @@ sub _ident_values {
   return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
 }
 
-=head2 set_primary_key <@cols>
+=head2 set_primary_key(@cols)
 
-define one or more columns as primary key for this class
+Defines one or more columns as primary key for this class. Should be
+called after C<columns>.
 
 =cut
 
@@ -51,9 +52,9 @@ sub set_primary_key {
   $class->_primaries(\%pri);
 }
 
-=head2 find
+=head2 find(@colvalues), find(\%cols)
 
-Finds columns based on the primary key(s).
+Finds a row based on its primary key(s).
 
 =cut
 
@@ -86,7 +87,8 @@ sub find {
 
 =head2 discard_changes
 
-Roll back changes that hasn't been comitted to the database.
+Re-selects the row from the database, losing any changes that had
+been made.
 
 =cut
 
@@ -106,7 +108,7 @@ sub discard_changes {
 
 =head2 id
 
-returns the primary key(s) for the current row. Can't be called as
+Returns the primary key(s) for a row. Can't be called as
 a class method.
 
 =cut
@@ -118,9 +120,10 @@ sub id {
   return (wantarray ? @pk : $pk[0]);
 }
 
-=head2  primary_columns
+=head2 primary_columns
 
-read-only accessor which returns a list of primary keys.
+Read-only accessor which returns the list of primary keys for a class
+(in scalar context, only returns the first primary key).
 
 =cut
 
@@ -128,6 +131,14 @@ sub primary_columns {
   return keys %{shift->_primaries};
 }
 
+=head2 ID
+
+Returns a unique id string identifying a row object by primary key.
+Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and 
+L<DBIx::Class::ObjectCache>.
+
+=cut
+
 sub ID {
   my ($self) = @_;
   $self->throw( "Can't call ID() as a class method" ) unless ref $self;