DOCSP-35011: ConnectionId class changes #495
Merged
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
jordan-smith721
requested changes
Jan 10, 2024
source/upgrade.txt
Outdated
|
|
||
| The ``ConnectionId`` constructor now accepts a value of type ``long`` as its second | ||
| parameter instead of type ``int``. Similarly, the constructor now accepts a value of | ||
| type ``Long`` as its third parameter instead of type ``Integer``. Since this change breaks |
There was a problem hiding this comment.
Style Guide: Don't use "since" to explain why, instead use "because"
Suggested change
| type ``Long`` as its third parameter instead of type ``Integer``. Since this change breaks | |
| type ``Long`` as its third parameter instead of type ``Integer``. Because this change breaks |
source/upgrade.txt
Outdated
| binary compatibility, recompile any existing code that calls the ``ConnectionId`` constructor. | ||
|
|
||
| The ``withServerValue()`` method now accepts a parameter of type ``long`` rather than | ||
| type ``int``. This change also breaks binary compatibility, so you must recompile any code |
There was a problem hiding this comment.
Suggestion: I don't think "also" is needed here, especially if a reader didn't read the previous change
Suggested change
| type ``int``. This change also breaks binary compatibility, so you must recompile any code | |
| type ``int``. This change breaks binary compatibility, so you must recompile any code |
source/upgrade.txt
Outdated
|
|
||
| The ``getServerValue()`` method now returns a value of type ``Long`` instead of type | ||
| ``Integer``. Similarly, the ``getLocalValue()`` method returns a value of type | ||
| ``long`` instead of type ``int``. Since this change breaks both binary and source |
There was a problem hiding this comment.
Same as above comment regarding "since"
Suggested change
| ``long`` instead of type ``int``. Since this change breaks both binary and source | |
| ``long`` instead of type ``int``. Because this change breaks both binary and source |
source/upgrade.txt
Outdated
|
|
||
| - Several changes were made to the ``ConnectionId`` class. | ||
|
|
||
| The ``ConnectionId`` constructor now accepts a value of type ``long`` as its second |
There was a problem hiding this comment.
I think these could be nested bullets for easier readability (applies to all nested paragraphs in this section)
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 is a Java 5.0 ticket.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-35011
Staging:
https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-35011-connectionid-return-types/whats-new/
https://preview-mongodbnorareidy.gatsbyjs.io/java/DOCSP-35011-connectionid-return-types/upgrade/#std-label-java-breaking-changes-v5.0
Self-Review Checklist