Slight change to prefetch documentation
Ben Hutton [Fri, 25 Jul 2014 10:54:07 +0000 (11:54 +0100)]
Added some calrification to the documentation on the prefetch attribute. It was unclear to me at first glance how it was different from join. The additional information explicityly explains without the expectation of knowing about all the other functions.

lib/DBIx/Class/ResultSet.pm

index b703c8f..e0bf58f 100644 (file)
@@ -4360,8 +4360,10 @@ For a more in-depth discussion, see L</PREFETCHING>.
 
 =back
 
-This attribute is a shorthand for specifying a L</join> spec, adding all
-columns from the joined related sources as L</+columns> and setting
+While the L<join> attribute will join a table without including the tables 
+columns in the select, prefetch will add the columns to the select spec at 
+the same time. This attribute is a shorthand for specifying a L</join> spec, 
+adding all columns from the joined related sources as L</+columns> and setting
 L</collapse> to a true value. For example, the following two queries are
 equivalent: