New Cursor() stuff added to NEWS.rst

twisted · Oct 25, 2024 · d353dcc · d353dcc
1 parent 58f13c0
commit d353dcc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/source/NEWS.rst b/docs/source/NEWS.rst
@@ -19,6 +19,10 @@ API Changes
   - `as_class` argument of `find()`, `find_with_cursor()` and `find_one()`
   - old-style parameters of `find*()` methods: `spec`, `fields`, `cursor`
 - `find()`, `find_one()` and `find_with_cursor()` now supports `allow_partial_results` argument.
+- `find()` method now returns `Cursor()` instance that can be used as async generator to
+  asynchronously iterate over results. It can still be used as Deferred too, so this change
+  is backward-compatible.
+- `find_with_cursor()` is deprecated and will be removed in the next release.
 
 
 

diff --git a/txmongo/collection.py b/txmongo/collection.py
@@ -600,6 +600,8 @@ def find_with_cursor(
     ):
         """find_with_cursor(filter=None, projection=None, skip=0, limit=0, sort=None, batch_size=0, allow_partial_results=False)
 
+        This method is deprecated. Please use :meth:`find()` method which now returns :class:`Cursor` instance.
+
         Find documents in a collection and return them in one batch at a time.
 
         Arguments are the same as for :meth:`find()`.