github-migration/mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor: docs

Browse Source
This commit is contained in:
Kyle Banker 2011-03-23 15:30:27 -04:00
parent 53ad43fedc
commit 37f285bf0c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/mongo/collection.rb
View File

@ -157,8 +157,8 @@ module Mongo
# the normal cursor timeout behavior of the mongod process. When +false+, the returned cursor will never timeout. Note
# that disabling timeout will only work when #find is invoked with a block. This is to prevent any inadvertant failure to
# close the cursor, as the cursor is explicitly closed when block code finishes.
# @options opts [Block] :transformer optional block that can be handed to cursor for tranforming returned documents. Most valuable
# use is for converting hashes to instances of a class.
# @options opts [Block] :transformer (nil) a block for tranforming returned documents.
# This is normally used by object mappers to convert each returned document to an instance of a class.
#
# @raise [ArgumentError]
# if timeout is set to false and find is not invoked in a block