add CollectionProxy#uniq documentation

rails · May 27, 2012 · 55c0527 · 55c0527
1 parent 29713d7
commit 55c0527
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/activerecord/lib/active_record/associations/collection_proxy.rb b/activerecord/lib/active_record/associations/collection_proxy.rb
@@ -636,6 +636,27 @@ class CollectionProxy < Relation
       #
       #   Pet.find(4, 5, 6) # => ActiveRecord::RecordNotFound: Couldn't find all Pets with IDs (4, 5, 6)
 
+      ##
+      # :method: uniq
+      #
+      # :call-seq:
+      #   uniq()
+      #
+      # Specifies whether the records should be unique or not.
+      #
+      #   class Person < ActiveRecord::Base
+      #     has_many :pets
+      #   end
+      #
+      #   person.pets.select(:name)
+      #   # => [
+      #   #      #<Pet name: "Fancy-Fancy">,
+      #   #      #<Pet name: "Fancy-Fancy">
+      #   #    ]
+      #
+      #   person.pets.select(:name).uniq
+      #   # => [#<Pet name: "Fancy-Fancy">]
+
       ##
       # :method: count
       #