POD fix
Johannes Plunien [Sun, 14 Jun 2009 16:46:32 +0000 (16:46 +0000)]
lib/DBIx/Class/ResultSet/HashRef.pm

index c49fd1e..dba82d5 100644 (file)
@@ -86,7 +86,21 @@ sub hashref_first {
 
 =head2 hashref_pk( )
 
-Calls L</hashref_array( )> and returns a reference to a hash containing the primary key. For each key the corresponding value is a reference to a hash of the resultset inflated by L<DBIx::Class::ResultClass::HashRefInflator>.
+Returns a hash or reference to hash, depending on the calling context. The keys of the hash are
+the primary keys of each row return by L</hashref_array( )>:
+
+       {
+               1 => {
+                   'id'    => '1',
+                   'login' => 'root'
+               },
+               2 => {
+                   'id'    => '2',
+                   'login' => 'toor'
+               },
+       }
+
+Example usage:
 
     my $hashref_pk = $schema->resultset('User')->search( { } )->hashref_pk;
     print Dumper $hashref_pk