Skip to content

Commit e8d3bb4

Browse files
author
Ilya Priven
committed
release_notes.rst: nits
1 parent d655771 commit e8d3bb4

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

docs/release_notes.rst

+10-12
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Breaking changes:
2424
and :meth:`Indexn.scan <pynamodb.indexes.Index.scan>` are now instance methods.
2525
* :py:class:`~pynamodb.settings.OperationSettings` has been removed
2626

27-
Other major changes:
27+
Major changes:
2828

2929
* We are now compatible with `opentelemetry botocore instrumentation <https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-botocore>`_.
3030
* We've reduced our usage of botocore private APIs (:pr:`1079`). On multiple occasions, new versions
3131
of botocore broke PynamoDB, and this change lessens the likelihood of that happening in the future
3232
by reducing (albeit not eliminating) our reliance on private botocore APIs.
3333

34-
Other changes in this release:
34+
Minor changes:
3535

3636
* :meth:`~pynamodb.models.Model.save`, :meth:`~pynamodb.models.Model.update`, :meth:`~pynamodb.models.Model.delete_item`,
3737
and :meth:`~pynamodb.models.Model.delete` now accept a ``add_version_condition`` parameter.
@@ -147,8 +147,7 @@ v5.0.0
147147

148148
This is major release and contains breaking changes. Please read the notes below carefully.
149149

150-
Breaking changes
151-
================
150+
Breaking changes:
152151

153152
* Python 2 is no longer supported. Python 3.6 or greater is now required.
154153
* :py:class:`~pynamodb.attributes.UnicodeAttribute` and :py:class:`~pynamodb.attributes.BinaryAttribute` now support empty values (:pr:`830`)
@@ -166,18 +165,17 @@ Breaking changes
166165
* Remove ``pynamodb.connection.util.pythonic`` (:pr:`753`) and (:pr:`865`)
167166
* Remove ``ModelContextManager`` class (:pr:`861`)
168167

169-
Features
170-
========
168+
Features:
171169

172-
**Polymorphism**
170+
* **Polymorphism**
173171

174-
This release introduces :ref:`polymorphism` support via :py:class:`DiscriminatorAttribute <pynamodb.attributes.DiscriminatorAttribute>`.
175-
Discriminator values are written to DynamoDB and used during deserialization to instantiate the desired class.
172+
This release introduces :ref:`polymorphism` support via :py:class:`DiscriminatorAttribute <pynamodb.attributes.DiscriminatorAttribute>`.
173+
Discriminator values are written to DynamoDB and used during deserialization to instantiate the desired class.
176174

177-
**Model Serialization**
175+
* **Model Serialization**
178176

179-
THe ``Model`` class now includes public methods for serializing and deserializing its attributes.
180-
``Model.serialize`` and ``Model.deserialize`` convert the model to/from a dictionary of DynamoDB attribute values.
177+
The ``Model`` class now includes public methods for serializing and deserializing its attributes.
178+
``Model.serialize`` and ``Model.deserialize`` convert the model to/from a dictionary of DynamoDB attribute values.
181179

182180
Other changes in this release:
183181

0 commit comments

Comments
 (0)