clarify how SelfResultSet works, sorta

frioux · Jul 30, 2014 · 79ce1f7 · 79ce1f7
1 parent 2858d29
commit 79ce1f7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/DBIx/Class/Helper/Row/SelfResultSet.pm b/lib/DBIx/Class/Helper/Row/SelfResultSet.pm
@@ -33,6 +33,12 @@ row.  A good reason to do that would be if you had a ResultSet method that adds
 in some calculated data, like counts of a relationship.  You could use this to
 get at that counted data without duplicating the logic for the counting.
 
+Due to primitives provided by L<DBIx::Class::PK> this references the current
+values, or in C<DBIx::Class> terms, the dirty values.  So if you modify the
+primary columns it will be temporarily incorrect.  For what it's worth I'm not
+married to this behavior and I'd rather you get in touch with me before you
+depend on it.
+
 =head1 METHODS
 
 =head2 self_rs