Repository navigation
PYTHON-5900 - Clarify Cursor and CommandCursor docstrings to indicate… - #2900
Merged
Merged
Conversation
… where they are used
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies Cursor and CommandCursor/AsyncCommandCursor docstrings to explicitly state which public APIs construct and use these cursors, improving discoverability in the public-facing documentation.
Changes:
- Update
Cursor.__init__docstrings (sync/async) to mentionCollection.find/AsyncCollection.findas the primary entry points. - Expand
CommandCursorandAsyncCommandCursorclass docstrings to list the calling APIs that return these cursors. - Adjust the async command cursor module docstring to reflect
AsyncCommandCursor.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pymongo/synchronous/cursor.py | Clarifies that Collection.find creates/uses Cursor for query results. |
| pymongo/synchronous/command_cursor.py | Expands CommandCursor docstring with the public APIs that return it (needs minor reST fixes). |
| pymongo/asynchronous/cursor.py | Clarifies that AsyncCollection.find creates/uses AsyncCursor for query results. |
| pymongo/asynchronous/command_cursor.py | Renames module docstring and expands AsyncCommandCursor docstring with calling APIs (needs minor reST fixes). |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
… where they are used
PYTHON-5900
Changes in this PR
See ticket.
Test Plan
N/A.
Checklist
Checklist for Author
[ ] Did you update the changelog (if necessary)?[ ] Is there test coverage?[ ] Is any followup work tracked in a JIRA ticket? If so, add link(s).Checklist for Reviewer