PYTHON-6007 Fix versionchanged marker for text_opts in ClientEncryption.encrypt - #3028
Merged
blink1073 merged 1 commit intoSep 1, 2026
Merged
Conversation
…on.encrypt The text_opts parameter was added in 4.15.0 (PYTHON-5328, mongodbGH-2521), not 4.9 as the docstring copy-pasted from the adjacent range_opts entry.
blink1073
force-pushed
the
claude/python-6007-jira-ticket-0c9e30
branch
from
September 1, 2026 11:48
0deceb3 to
fa1adcd
Compare
blink1073
marked this pull request as ready for review
September 1, 2026 11:49
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the Sphinx versionchanged marker in ClientEncryption.encrypt’s docstring to accurately reflect when text_opts was introduced, aligning documentation with the actual release history.
Changes:
- Updated the
text_opts.. versionchanged::marker from4.9to4.15in the async encryption implementation docstring. - Regenerated the synchronized (generated) synchronous file to mirror the same docstring correction.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pymongo/asynchronous/encryption.py | Fixes the text_opts docstring versionchanged marker to 4.15. |
| pymongo/synchronous/encryption.py | Mirrors the same docstring marker correction via synchro regeneration. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
aclark4life
approved these changes
Sep 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PYTHON-6007
Summary
ClientEncryption.encrypt's docstring said thetext_optsparameter was added in 4.9, but it was actually added in 4.15.0.Motivation
The
versionchanged:: 4.9entry fortext_optswas copy-pasted from the adjacentrange_optsentry whentext_optswas introduced in PYTHON-5328 (GH-2521), which shipped in 4.15.0. Therange_optsentry itself is correct as-is; it really was added in 4.9.Changes
text_optsversionchangedmarker from 4.9 to 4.15 inpymongo/asynchronous/encryption.py.pymongo/synchronous/encryption.pyviajust synchro.Testing
just lintandjust typing(the two pre-existingpymongo/ocsp_support.pymypy errors reproduce identically onmainand are unrelated to this change).