aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/relation/batches.rb
diff options
context:
space:
mode:
authorMichael Dawson <michaeld@everydayhero.com.au>2014-12-19 15:42:40 +1000
committerMichael Dawson <michaeld@everydayhero.com.au>2014-12-19 15:42:40 +1000
commitd557f1bac0c9e52078432a4e205b2d4870616c2a (patch)
treef0c304cbb5cd3d925ce77a8946679be8ec93c74e /activerecord/lib/active_record/relation/batches.rb
parent65faa8f0da78dda1a180b52d8765893057af193f (diff)
downloadrails-d557f1bac0c9e52078432a4e205b2d4870616c2a.tar.gz
rails-d557f1bac0c9e52078432a4e205b2d4870616c2a.tar.bz2
rails-d557f1bac0c9e52078432a4e205b2d4870616c2a.zip
Clarity start parameter
I find that `Specifies the starting point for the batch processing.` does not give enough information for me to understand what this parameter actually does.
Diffstat (limited to 'activerecord/lib/active_record/relation/batches.rb')
-rw-r--r--activerecord/lib/active_record/relation/batches.rb4
1 files changed, 2 insertions, 2 deletions
diff --git a/activerecord/lib/active_record/relation/batches.rb b/activerecord/lib/active_record/relation/batches.rb
index 20d24b409b..4f0502ae75 100644
--- a/activerecord/lib/active_record/relation/batches.rb
+++ b/activerecord/lib/active_record/relation/batches.rb
@@ -27,7 +27,7 @@ module ActiveRecord
#
# ==== Options
# * <tt>:batch_size</tt> - Specifies the size of the batch. Default to 1000.
- # * <tt>:start</tt> - Specifies the starting point for the batch processing.
+ # * <tt>:start</tt> - Specifies the primary key value to start from.
# This is especially useful if you want multiple workers dealing with
# the same processing queue. You can make worker 1 handle all the records
# between id 0 and 10,000 and worker 2 handle from 10,000 and beyond
@@ -77,7 +77,7 @@ module ActiveRecord
#
# ==== Options
# * <tt>:batch_size</tt> - Specifies the size of the batch. Default to 1000.
- # * <tt>:start</tt> - Specifies the starting point for the batch processing.
+ # * <tt>:start</tt> - Specifies the primary key value to start from.
# This is especially useful if you want multiple workers dealing with
# the same processing queue. You can make worker 1 handle all the records
# between id 0 and 10,000 and worker 2 handle from 10,000 and beyond