aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/associations
diff options
context:
space:
mode:
authorFrancesco Rodriguez <lrodriguezsanc@gmail.com>2012-11-29 12:58:31 -0500
committerFrancesco Rodriguez <lrodriguezsanc@gmail.com>2012-11-29 12:58:31 -0500
commitabdfffa2139355d7ccb6d8fd91a6bb21f2f1b8d8 (patch)
treeede5b0d5fd3da127deb7a7c6c045ff0000c4cc99 /activerecord/lib/active_record/associations
parent61a7a9f38bfce21bbeb1dd09efabc4f1002cc00d (diff)
downloadrails-abdfffa2139355d7ccb6d8fd91a6bb21f2f1b8d8.tar.gz
rails-abdfffa2139355d7ccb6d8fd91a6bb21f2f1b8d8.tar.bz2
rails-abdfffa2139355d7ccb6d8fd91a6bb21f2f1b8d8.zip
add documentation to CollectionProxy #length and #size methods [ci skip]
Diffstat (limited to 'activerecord/lib/active_record/associations')
-rw-r--r--activerecord/lib/active_record/associations/collection_proxy.rb9
1 files changed, 7 insertions, 2 deletions
diff --git a/activerecord/lib/active_record/associations/collection_proxy.rb b/activerecord/lib/active_record/associations/collection_proxy.rb
index d57fa40b91..a9a4eb8728 100644
--- a/activerecord/lib/active_record/associations/collection_proxy.rb
+++ b/activerecord/lib/active_record/associations/collection_proxy.rb
@@ -672,7 +672,11 @@ module ActiveRecord
end
# Returns the size of the collection. If the collection hasn't been loaded,
- # it executes a <tt>SELECT COUNT(*)</tt> query.
+ # it executes a <tt>SELECT COUNT(*)</tt> query. If it has, calls <tt>collection.size</tt>.
+ #
+ # If the collection has been already loaded +size+ and +length+ are
+ # equivalent. If not and you are going to need the records anyway
+ # +length+ will take one less query. Otherwise +size+ is more efficient.
#
# class Person < ActiveRecord::Base
# has_many :pets
@@ -697,7 +701,8 @@ module ActiveRecord
# Returns the size of the collection calling +size+ on the target.
# If the collection has been already loaded, +length+ and +size+ are
- # equivalent.
+ # equivalent. If not and you are going to need the records anyway this
+ # method will take one less query. Otherwise +size+ is more efficient.
#
# class Person < ActiveRecord::Base
# has_many :pets