Skip to content

Commit 275e8c3

Browse files
committed
Documentation and changelog updates for 3.2
1 parent 13f86c5 commit 275e8c3

File tree

7 files changed

+39
-12
lines changed

7 files changed

+39
-12
lines changed

doc/api/bson/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Sub-modules:
1111
:maxdepth: 2
1212

1313
binary
14-
regex
1514
code
1615
codec_options
1716
dbref
@@ -21,6 +20,8 @@ Sub-modules:
2120
max_key
2221
min_key
2322
objectid
23+
raw_bson
24+
regex
2425
son
2526
timestamp
2627
tz_util

doc/api/bson/raw_bson.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:mod:`raw_bson` -- Tools for representing raw BSON documents.
2+
=============================================================
3+
.. automodule:: bson.raw_bson
4+
:synopsis: Tools for representing raw BSON documents.
5+
:members:

doc/api/pymongo/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Sub-modules:
4343
mongo_replica_set_client
4444
operations
4545
pool
46+
read_concern
4647
read_preferences
4748
results
4849
son_manipulator

doc/api/pymongo/read_concern.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:mod:`read_concern` -- Tools for working with read concern.
2+
===========================================================
3+
4+
.. automodule:: pymongo.read_concern
5+
:synopsis: Tools for working with read concern.
6+
:members:
7+
:inherited-members:

doc/changelog.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,23 @@ Version 3.2 implements the new server features introduced in MongoDB 3.2.
88

99
Highlights include:
1010

11-
- Certain MongoClient properties block until a connection is established or
12-
raise ServerSelectionTimeoutError if no server is available. See
13-
:class:`~pymongo.MongoClient` for details.
11+
- Full support for MongoDB 3.2 including:
12+
13+
- Support for :class:`~pymongo.read_concern.ReadConcern`
14+
- :class:`~pymongo.write_concern.WriteConcern` is now applied to
15+
:meth:`~pymongo.collection.Collection.find_one_and_replace`,
16+
:meth:`~pymongo.collection.Collection.find_one_and_update`, and
17+
:meth:`~pymongo.collection.Collection.find_one_and_delete`.
18+
- Support for the new `bypassDocumentValidation` option in write
19+
helpers.
20+
21+
- Support for reading and writing raw BSON with
22+
:class:`~bson.raw_bson.RawBSONDocument`
23+
24+
.. note:: Certain :class:`~pymongo.mongo_client.MongoClient` properties now
25+
block until a connection is established or raise
26+
:exc:`~pymongo.errors.ServerSelectionTimeoutError` if no server is available.
27+
See :class:`~pymongo.mongo_client.MongoClient` for details.
1428

1529
Changes in Version 3.1.1
1630
------------------------

doc/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@ but can be found on the
233233
`github tags page <https://github.com/mongodb/mongo-python-driver/tags>`_.
234234
They can be installed by passing the full URL for the tag to pip::
235235

236-
$ pip install https://github.com/mongodb/mongo-python-driver/archive/3.1rc0.tar.gz
236+
$ pip install https://github.com/mongodb/mongo-python-driver/archive/3.2rc0.tar.gz
237237

238238
or easy_install::
239239

240-
$ easy_install https://github.com/mongodb/mongo-python-driver/archive/3.1rc0.tar.gz
240+
$ easy_install https://github.com/mongodb/mongo-python-driver/archive/3.2rc0.tar.gz
241241

pymongo/cursor.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -473,19 +473,18 @@ def max_time_ms(self, max_time_ms):
473473

474474
def max_await_time_ms(self, max_await_time_ms):
475475
"""Specifies a time limit for a getMore operation on a
476-
:attr:`~pymongo.CursorType.TAILABLE_AWAIT` cursor. For all other types
477-
of cursor max_await_time_ms is ignored.
476+
:attr:`~pymongo.cursor.CursorType.TAILABLE_AWAIT` cursor. For all other
477+
types of cursor max_await_time_ms is ignored.
478478
479479
Raises :exc:`TypeError` if `max_await_time_ms` is not an integer or
480-
``None``.
481-
Raises :exc:`~pymongo.errors.InvalidOperation` if this :class:`Cursor`
482-
has already been used.
480+
``None``. Raises :exc:`~pymongo.errors.InvalidOperation` if this
481+
:class:`Cursor` has already been used.
483482
484483
.. note:: `max_await_time_ms` requires server version **>= 3.2**
485484
486485
:Parameters:
487486
- `max_await_time_ms`: the time limit after which the operation is
488-
aborted
487+
aborted
489488
490489
.. versionadded:: 3.2
491490
"""

0 commit comments

Comments
 (0)