From 952737af35be26ac4760efa3b06a0313ceae2c68 Mon Sep 17 00:00:00 2001
From: Francesco Rodriguez <lrodriguezsanc@gmail.com>
Date: Sat, 19 May 2012 14:58:19 -0500
Subject: add CollectionProxy#find documentation

---
 .../active_record/associations/collection_proxy.rb   | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'activerecord/lib/active_record')

diff --git a/activerecord/lib/active_record/associations/collection_proxy.rb b/activerecord/lib/active_record/associations/collection_proxy.rb
index fa316a8c9d..1c22309d99 100644
--- a/activerecord/lib/active_record/associations/collection_proxy.rb
+++ b/activerecord/lib/active_record/associations/collection_proxy.rb
@@ -36,6 +36,26 @@ module ActiveRecord
     class CollectionProxy < Relation
       delegate :target, :load_target, :loaded?, :to => :@association
 
+      ##
+      # :method: find
+      # Finds an object in the collection responding to the +id+. Uses the same
+      # rules as +ActiveRecord::Base.find+. Returns +ActiveRecord::RecordNotFound++
+      # error if the object can not be found.
+      #
+      #   class Person < ActiveRecord::Base
+      #     has_many :pets
+      #   end
+      #
+      #   person.pets
+      #   # => [
+      #   #       #<Pet id: 1, name: "Fancy-Fancy", person_id: 1>,
+      #   #       #<Pet id: 2, name: "Spook", person_id: 1>,
+      #   #       #<Pet id: 3, name: "Choo-Choo", person_id: 1>
+      #   #    ]  
+      #   
+      #   person.pets.find(1) # => #<Pet id: 1, name: "Fancy-Fancy", person_id: 1>
+      #   person.pets.find(4) # => ActiveRecord::RecordNotFound: Couldn't find Pet with id=4
+
       ##
       # :method: first
       # Returns the first record, or the first +n+ records, from the collection.
-- 
cgit v1.2.3