From a3bd42cd7af3b87347757470b412a75d55d06707 Mon Sep 17 00:00:00 2001 From: Maya Raman Date: Tue, 22 Oct 2024 10:29:46 -0400 Subject: [PATCH 1/3] added breaking changes info --- source/upgrade.txt | 8 ++++++++ source/whats-new.txt | 6 ++++++ 2 files changed, 14 insertions(+) diff --git a/source/upgrade.txt b/source/upgrade.txt index 692ecdb5..de1933eb 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -104,6 +104,14 @@ and upgrade versions. .. diagram for this example? +.. _version-4.9-breaking-changes: + +Version 4.9 Breaking Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- ``pymongocrypt`` v1.10 or later is required for + :manual:`Client-Side Field Level Encryption ` (CSFLE). + .. _version-4.8-breaking-changes: Version 4.8 Breaking Changes diff --git a/source/whats-new.txt b/source/whats-new.txt index cae1f0ec..2d542779 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -47,6 +47,11 @@ The {+driver-short+} v4.10 release includes the following new features: What's New in 4.9 ----------------- +.. warning:: Breaking Changes + + {+driver-short+} v4.9 contains breaking changes. For more information, see + :ref:`version-4.9-breaking-changes`. + The {+driver-short+} v4.9 release includes the following new features: - Adds support for {+mdb-server+} 8.0 and Python 3.13. @@ -56,6 +61,7 @@ The {+driver-short+} v4.9 release includes the following new features: Encryption ` in the {+mdb-server+} manual. - Adds a new experimental asynchronous API as a replacement for Motor. This API is in beta and is subject to change before the generally available release. + .. TODO: Add link to the Pymongo Async migration guide .. _version-4.8: From d2c8698e60cb7ec69e2b82ba95e1b91067301caf Mon Sep 17 00:00:00 2001 From: Maya Raman Date: Tue, 22 Oct 2024 10:57:23 -0400 Subject: [PATCH 2/3] updating bullet points --- source/upgrade.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index de1933eb..6a6665cf 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -109,8 +109,8 @@ and upgrade versions. Version 4.9 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- ``pymongocrypt`` v1.10 or later is required for - :manual:`Client-Side Field Level Encryption ` (CSFLE). +- ``pymongocrypt`` v1.10 or later is required for :manual:`Client-Side Field + Level Encryption ` (CSFLE). .. _version-4.8-breaking-changes: From 141a28865590828ab8a2d3cfb06d6d410bab1b12 Mon Sep 17 00:00:00 2001 From: Maya Raman Date: Tue, 22 Oct 2024 11:51:33 -0400 Subject: [PATCH 3/3] addressing feedback --- source/upgrade.txt | 4 ++-- source/whats-new.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index 6a6665cf..e3b8247a 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -109,8 +109,8 @@ and upgrade versions. Version 4.9 Breaking Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- ``pymongocrypt`` v1.10 or later is required for :manual:`Client-Side Field - Level Encryption ` (CSFLE). +- You must use ``pymongocrypt`` v1.10 or later to use :manual:`Client-Side Field + Level Encryption ` (CSFLE) in your application. .. _version-4.8-breaking-changes: diff --git a/source/whats-new.txt b/source/whats-new.txt index 2d542779..2df9fd59 100644 --- a/source/whats-new.txt +++ b/source/whats-new.txt @@ -49,8 +49,8 @@ What's New in 4.9 .. warning:: Breaking Changes - {+driver-short+} v4.9 contains breaking changes. For more information, see - :ref:`version-4.9-breaking-changes`. + {+driver-short+} v4.9 contains breaking changes. For more information, see + :ref:`version-4.9-breaking-changes`. The {+driver-short+} v4.9 release includes the following new features: