PYTHON-1808 - Document uuidRepresentation

behackett · behackett · commit 2f06e8a441fe · 2019-04-16T16:26:09.000-07:00
diff --git a/bson/binary.py b/bson/binary.py
@@ -49,8 +49,7 @@
 """BSON binary subtype for a UUID.
 
 This is the new BSON binary subtype for UUIDs. The
-current default is :data:`OLD_UUID_SUBTYPE` but will
-change to this in a future release.
+current default is :data:`OLD_UUID_SUBTYPE`.
 
 .. versionchanged:: 2.1
    Changed to subtype 4.
diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -94,6 +94,10 @@ Changes in Version 3.8.0.dev0
   :meth:`~pymongo.cursor.Cursor.hint` of which index to use. The find command
   is expected to require a :meth:`~pymongo.cursor.Cursor.hint` when using
   min/max starting in MongoDB 4.2.
+- Documented support for the uuidRepresentation URI option, which has been
+  supported since PyMongo 2.7. Valid values are `pythonLegacy` (the default),
+  `javaLegacy`, `csharpLegacy` and `standard`. New applications should consider
+  setting this to `standard` for cross language compatibility.
 
 Issues Resolved
 ...............
diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py
@@ -294,6 +294,11 @@ def __init__(
             are -1 through 9. -1 tells the zlib library to use its default
             compression level (usually 6). 0 means no compression. 1 is best
             speed. 9 is best compression. Defaults to -1.
+          - `uuidRepresentation`: The BSON representation to use when encoding
+            from and decoding to instances of :class:`~uuid.UUID`. Valid
+            values are `pythonLegacy` (the default), `javaLegacy`,
+            `csharpLegacy` and `standard`. New applications should consider
+            setting this to `standard` for cross language compatibility.
 
           | **Write Concern options:**
           | (Only set if passed. No default values.)
