From: Justin Guenther <jguenther@cpan.org>
Date: Mon, 19 Jun 2006 20:38:16 +0000 (+0000)
Subject: docs clarification for set_$rel
X-Git-Tag: v0.07002~75^2~93^2~2
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=bba68c6771e097c210e6eded8b2ab18a17910467;p=dbsrgits%2FDBIx-Class.git

docs clarification for set_$rel
---

diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm
index ac0ecf9..7bfcd13 100644
--- a/lib/DBIx/Class/Relationship/Base.pm
+++ b/lib/DBIx/Class/Relationship/Base.pm
@@ -422,8 +422,13 @@ B<Currently only available for C<many-to-many> relationships.>
      # Replaces all of $actors previous roles with the two named
 
 Replace all the related objects with the given list of objects. This does a
-C<delete> to remove all related objects, then calls C<add_to_$rel>
-repeatedly to link all the new objects.
+C<delete> B<on the link table resultset> to remove the association between the
+current object and all related objects, then calls C<add_to_$rel> repeatedly to
+link all the new objects.
+
+Note that this means that this method will B<not> delete any objects in the
+table on the right side of the relation, merely that it will delete the link
+between them.
 
 =head2 remove_from_$rel