PYTHON-3018 Add docs for removed methods from Collection #801
Conversation
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
juliusgeo
requested review from
ShaneHarvey
and removed request for
ShaneHarvey
juliusgeo
commented
Nov 22, 2021
doc/api/pymongo/collection.rst
Outdated
|
|
||
| Removed. Use :meth:`pymongo.collection.Collection.bulk_write` | ||
| instead. Code like this:: | ||
| batch = coll.initialize_(un)ordered_bulk_op() |
There was a problem hiding this comment.
Not sure if it would be better to separate into two sections. Saying "(un)ordered" makes sense to me but might not be clear to the user.
ShaneHarvey
requested changes
Nov 22, 2021
There was a problem hiding this comment.
Instead of duplicating the docs from the migration guide, let's link to the guide itself. Something like this:
..versionchanged:: 4.0
Removed the insert, save, count, .... methods. See the <link to migration guide>.
We can put this in the Collection docstring.
ShaneHarvey
requested changes
Nov 23, 2021
| parallel_scan, initialize_unordered_bulk_op, | ||
| initialize_ordered_bulk_op, group, count, insert, save, | ||
| update, remove, find_and_modify, and ensure_index methods. See the | ||
| :ref:`pymongo4-migration-guide`. |
There was a problem hiding this comment.
Perfect, can you make a similar change for MongoClient and Database?
ShaneHarvey
requested changes
Nov 23, 2021
| @@ -503,6 +503,11 @@ def __init__( | |||
|
|
|||
| .. seealso:: The MongoDB documentation on `connections <https://dochub.mongodb.org/core/connections>`_. | |||
|
|
|||
| .. versionchanged:: 4.0 | |||
There was a problem hiding this comment.
Please combine this with the existing versionchanged below.
juliusgeo
added a commit
to juliusgeo/mongo-python-driver
that referenced
this pull request
Apr 5, 2022
juliusgeo
added a commit
to juliusgeo/mongo-python-driver
that referenced
this pull request
Apr 7, 2022
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.
No description provided.