Update docstrings and HISTORY.rst

Scille · Sep 11, 2020 · f691b35 · f691b35
1 parent ffea698
commit f691b35
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -8,6 +8,21 @@ History
 Features:
 
 * Add support for motor 2.2 (see #294). (Picked from 2.3.0.)
+* *Backwards-incompatible*: Add ``ExposeMissing`` context manager to return
+  ``missing`` rather than ``None`` when dumping. Replace ``FromUmongoSchema``
+  with ``RemoveMissingSchema``. This schema removes missing fields when dumping
+  by using ``ExposeMissing`` internally. Make this feature opt-in by requiring
+  the user to specify ``RemoveMissingSchema`` as ``MA_BASE_SCHEMA_CLS``.
+  (see #261)
+* *Backwards-incompatible*: Remove ``mongo_world`` parameter from
+  ``Schema.as_marshmallow_schema``. Schemas generated by this method are meant
+  to (de)serialize umongo objects, not ``dict`` straight from database.
+  (see #299)
+
+Other changes:
+
+* *Backwards-incompatible*: Drop Python 3.6 support (see #298).
+
 
 3.0.0b8 (2020-07-22)
 --------------------

diff --git a/umongo/schema.py b/umongo/schema.py
@@ -13,8 +13,9 @@
 
 class RemoveMissingSchema(ma.Schema):
     """
-    Custom :class:`marshmallow.Schema` subclass returning missing rather than
-    None for missing fields in umongo :class:`umongo.Document`s.
+    Custom :class:`marshmallow.Schema` subclass that skips missing fields
+    rather than returning None for missing fields when dumping umongo
+    :class:`umongo.Document`s.
     """
     def dump(self, *args, **kwargs):
         with ExposeMissing():