Changelog for 3.1

bson/codec_options.py

@@ -44,19 +44,17 @@ class CodecOptions(_options_base):
         and decoding instances of :class:`~uuid.UUID`. Defaults to
         :data:`~bson.binary.PYTHON_LEGACY`.
       - `unicode_decode_error_handler`: The error handler to use when decoding
-         an invalid BSON string. Valid options include 'strict', 'replace', and
-         'ignore'. Defaults to 'strict'.
+        an invalid BSON string. Valid options include 'strict', 'replace', and
+        'ignore'. Defaults to 'strict'.
+      - `tzinfo`: A :class:`~datetime.tzinfo` subclass that specifies the
+        timezone to/from which :class:`~datetime.datetime` objects should be
+        encoded/decoded.
 
     .. warning:: Care must be taken when changing
        `unicode_decode_error_handler` from its default value ('strict').
        The 'replace' and 'ignore' modes should not be used when documents
        retrieved from the server will be modified in the client application
        and stored back to the server.
-
-      - `tzinfo`: A :class:`~datetime.tzinfo` subclass that specifies the
-        timezone to/from which :class:`~datetime.datetime` objects should be
-        encoded/decoded.
-
     """
 
     def __new__(cls, document_class=dict,

doc/changelog.rst

@@ -1,6 +1,31 @@
 Changelog
 =========
 
+Changes in Version 3.1
+----------------------
+
+Version 3.1 implements a few new features and fixes bugs reported since the release
+of 3.0.3.
+
+Highlights include:
+
+- Command monitoring support. See :mod:`~pymongo.monitoring` for details.
+- Configurable error handling for :exc:`UnicodeDecodeError`. See the
+  `unicode_decode_error_handler` option of
+  :class:`~bson.codec_options.CodecOptions`.
+- Optional automatic timezone conversion when decoding BSON datetime. See the
+  `tzinfo` option of :class:`~bson.codec_options.CodecOptions`.
+- An implementation of :class:`~gridfs.GridFSBucket` from the new GridFS spec.
+- Compliance with the new Connection String spec.
+
+Issues Resolved
+...............
+
+See the `PyMongo 3.1 release notes in JIRA`_ for the list of resolved issues
+in this release.
+
+.. _PyMongo 3.1 release notes in JIRA: https://jira.mongodb.org/browse/PYTHON/fixforversion/14796
+
 Changes in Version 3.0.3
 ------------------------