RUBY-437

Document batchSize better
ismell · May 14, 2012 · 8a49614 · 8a49614
1 parent 6663660
commit 8a49614
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/lib/mongo/collection.rb b/lib/mongo/collection.rb
@@ -184,7 +184,7 @@ def hint=(hint=nil)
     #   end of the query's execution.
     #   For details see http://www.mongodb.org/display/DOCS/How+to+do+Snapshotting+in+the+Mongo+Database
     # @option opts [Boolean] :batch_size (100) the number of documents to returned by the database per
-    #   GETMORE operation. A value of 0 will let the database server decide how many results to returns.
+    #   GETMORE operation. A value of 0 will let the database server decide how many results to return.
     #   This option can be ignored for most use cases.
     # @option opts [Boolean] :timeout (true) when +true+, the returned cursor will be subject to
     #   the normal cursor timeout behavior of the mongod process. When +false+, the returned cursor will

diff --git a/lib/mongo/cursor.rb b/lib/mongo/cursor.rb
@@ -258,6 +258,9 @@ def skip(number_to_skip=nil)
     #
     # Note that the batch size will take effect only on queries
     # where the number to be returned is greater than 100.
+    # 
+    # This can not override MongoDB's limit on the amount of data it will
+    # return to the client. Depending on server version this can be 4-16mb.
     #
     # @param [Integer] size either 0 or some integer greater than 1. If 0,
     #   the server will determine the batch size.