-
Notifications
You must be signed in to change notification settings - Fork 41
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.
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
Reorganize 5.0 release notes #524
Reorganize 5.0 release notes #524
Conversation
<https://mongodb.github.io/mongo-java-driver/4.11/apidocs/mongodb-driver-core/com/mongodb/connection/StreamFactory.html>`__ | ||
|
||
- Removes the following methods and types related to the | ||
- Removes the following methods and types related to the | ||
`Stream | ||
<https://mongodb.github.io/mongo-java-driver/4.11/apidocs/mongodb-driver-core/com/mongodb/connection/Stream.html>`__ | ||
interface: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This duplication probably happened as a result of (presumably) rebasing and manually resolving non-trivial conflicts in #513 after the review had been completed.
5585f30
to
f581f0f
Compare
I can't check if formatting / links work properly as I don't know how to stage the changes. |
Co-authored-by: Jeff Yemin <[email protected]>
Co-authored-by: Jeff Yemin <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One change for consistency through the whole doc:
@@ -40,37 +40,65 @@ Learn what's new in: | |||
What's New in 5.0 | |||
----------------- | |||
|
|||
.. warning:: Breaking Changes in v5.0 | |||
.. warning:: Breaking changes in this release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the What's New sections for previous releases, this should be left as it is.
.. warning:: Breaking changes in this release | |
.. warning:: Breaking Changes in v5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the warning about deprecations in 4.11 (the latest release at the moment) uses the "Deprecations in this release" wording. This suggests that the wording was changed since release 4.8, where the wording is "Breaking Changes in v4.8". @rachel-mack Are you sure the old wording should be used again?
@rachel-mack I haven't done any of the tasks in the "Self-Review Checklist", and the build is failing. Should someone from the docs team address all of that, or do you want this PR to be merged as is? |
✨ Staging URL: https://mongodbcom-cdn.website.staging.corp.mongodb.com/java/docsworker-xlarge/master/ 🪵 Logs |
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-NNNNN
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/
Self-Review Checklist