aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArthur Nogueira Neves <arthurnn@gmail.com>2014-12-20 13:16:56 -0500
committerArthur Nogueira Neves <arthurnn@gmail.com>2014-12-20 13:16:56 -0500
commit155a21fe01d4f3489167d2340836b9c4b20e5b53 (patch)
tree2ac391c69a3fb8b394589beb91f672ccaabbdddb
parent34cd7e2b1a1b5be175d79c3233a97393b01b8bad (diff)
parentd557f1bac0c9e52078432a4e205b2d4870616c2a (diff)
downloadrails-155a21fe01d4f3489167d2340836b9c4b20e5b53.tar.gz
rails-155a21fe01d4f3489167d2340836b9c4b20e5b53.tar.bz2
rails-155a21fe01d4f3489167d2340836b9c4b20e5b53.zip
Merge pull request #18092 from nippysaurus/clarity_batch_starting_point
Update description for `start` parameter.
-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