Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

PYTHON-499 clarify cursor timeout documentation

  • Loading branch information...
commit d80ed73ba425bf132f6ef426d2334f597ea6d2c9 1 parent 6473e07
@ajdavis ajdavis authored
Showing with 5 additions and 5 deletions.
  1. +5 −5 pymongo/collection.py
View
10 pymongo/collection.py
@@ -629,11 +629,11 @@ def find(self, *args, **kwargs):
the start of the result set) when returning the results
- `limit` (optional): the maximum number of results to
return
- - `timeout` (optional): if True, any returned cursor will be
- subject to the normal timeout behavior of the mongod
- process. Otherwise, the returned cursor will never timeout
- at the server. Care should be taken to ensure that cursors
- with timeout turned off are properly closed.
+ - `timeout` (optional): if True (the default), any returned
+ cursor is closed by the server after 10 minutes of
+ inactivity. If set to False, the returned cursor will never
+ time out on the server. Care should be taken to ensure that
+ cursors with timeout turned off are properly closed.
- `snapshot` (optional): if True, snapshot mode will be used
for this query. Snapshot mode assures no duplicates are
returned, or objects missed, which were present at both
Please sign in to comment.
Something went wrong with that request. Please try again.