Skip to content

DOCSP-493767 Update migration admonitions to clarify release phases #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 18, 2025
Merged

DOCSP-493767 Update migration admonitions to clarify release phases #261

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
96fcdcb
update admonitions
stephmarie17 Apr 17, 2025
6e0d77e
wording
stephmarie17 Apr 17, 2025
dd4a556
rr feedback
stephmarie17 Apr 18, 2025
c0eaaa9
vale fix
stephmarie17 Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/includes/pymongo-async-experimental.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The {+driver-async+} driver is experimental and should not be used in
production environments. Classes, methods, and behaviors described in this
guide might change prior to the full release. If you encounter any
guide might change prior to the production release. If you encounter any

Check failure on line 5 in source/includes/pymongo-async-experimental.rst

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.Wordiness] Consider using 'before' instead of 'prior to'.

Raw Output:
{"message": "[MongoDB.Wordiness] Consider using 'before' instead of 'prior to'.", "location": {"path": "source/includes/pymongo-async-experimental.rst", "range": {"start": {"line": 5, "column": 23}}}, "severity": "ERROR"}

Check failure on line 5 in source/includes/pymongo-async-experimental.rst

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'before' is preferred over 'prior to'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'before' is preferred over 'prior to'.", "location": {"path": "source/includes/pymongo-async-experimental.rst", "range": {"start": {"line": 5, "column": 23}}}, "severity": "ERROR"}
issues with {+driver-async+}, you can learn how to report them on the
:ref:`pymongo-issues-help` page.
9 changes: 6 additions & 3 deletions source/reference/migration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,12 @@

.. warning:: Motor Deprecation

Motor will be deprecated one year after the production release of the {+driver-async+}
driver. We strongly recommend that Motor users migrate to the {+driver-async+} driver while
Motor is still supported.
The {+driver-async+} driver is currently experimental and should not be used

Check failure on line 64 in source/reference/migration.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'now' is preferred over 'currently'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'now' is preferred over 'currently'.", "location": {"path": "source/reference/migration.txt", "range": {"start": {"line": 64, "column": 35}}}, "severity": "ERROR"}

Check failure on line 64 in source/reference/migration.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.

Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/reference/migration.txt", "range": {"start": {"line": 64, "column": 62}}}, "severity": "ERROR"}
in production environments.

Motor will be deprecated one year after the **production release** of the
{+driver-async+} driver. We strongly recommend that Motor users migrate to
the {+driver-async+} driver while Motor is still supported.

The {+driver-async+} driver functions similarly to the Motor library, but allows
for improved latency and throughput due to directly using Python Asyncio instead
Expand Down
Loading