MongoDB: document changes in 2.0.0 #4618
Merged
Conversation
This file contains 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
|
Note: I'm working on fixing the build error. |
GromNaN
reviewed
Apr 15, 2025
alcaeus
force-pushed
the
mongodb-2.0.0-changes
branch
from
3da0758 to
37994a8
Compare
GromNaN
approved these changes
Apr 17, 2025
| @@ -56,6 +56,7 @@ | |||
| </row> | |||
| </thead> | |||
| <tbody> | |||
| &mongodb.changelog.tentative-return-types-enforced; | |||
There was a problem hiding this comment.
I think an example should be added to show that it is not necessary to add all return types with covariance. We can create a ticket to do this later.
There was a problem hiding this comment.
Yeah, we can consider doing this later. Let's see how many people struggle with the change.
Comment on lines
+392
to
+396
| A negative value for the <literal>"limit"</literal> option no longer | ||
| implies &true; for the <literal>"singleBatch"</literal> option. To only | ||
| receive a single batch of results, combine a positive | ||
| <literal>"limit"</literal> value with the | ||
| <literal>"singleBatch"</literal> option. |
There was a problem hiding this comment.
I like the way you move the documentation of the removed option so people using a legacy version of the driver can still find their description even if the doc is not versioned.
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.
This adds documentation changes for MongoDB 2.0. Documentation for methods and classes that were removed has been preserved - however I have removed deprecated constants and options for brevity.
Classes and methods that were removed in 2.0 will be removed from the docs at a future date.