[JAVA] Relax the CMAP documentation requirement for durations in events #501
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
mongoKart
requested changes
Jan 16, 2024
source/whats-new.txt
Outdated
Comment on lines
57
to
73
| - The ``ConnectionCheckedOutEvent.getElapsedTime`` method now includes the time | ||
| taken to create the connection. That is, the "timer" starts before the | ||
| connection is confirmed, rather than after. | ||
|
|
There was a problem hiding this comment.
I think more technical detail would be helpful here. I'd probably just paste in the Jira notes and maybe edit them slightly.
Also, I think the ticket describes more changes than I see here; is there another ticket for those?
rachel-mack
force-pushed
the
DOCSP-35270
branch
from
1b774b1 to
7616b01
Compare
|
Note: Vale error is for use of "Fail" in the event name. |
mongoKart
requested changes
Jan 17, 2024
source/whats-new.txt
Outdated
| @@ -59,6 +59,18 @@ The 5.0 driver release introduces the following features: | |||
| ``isNumber()`` and ``asNumber()`` methods match the Java responses for | |||
| equivalent ``Decimal128`` values. | |||
|
|
|||
| - The ``getElapsedTime`` method on ``com.mongodb.event.ConnectionReadyEvent`` | |||
| includes the time taken to deliver the ``ConnectionPoolListener``. That is, | |||
There was a problem hiding this comment.
I: per ticket, i think this should be:
Suggested change
| includes the time taken to deliver the ``ConnectionPoolListener``. That is, | |
| includes the time taken to deliver the ``ConnectionCreatedEvent``. That is, |
source/whats-new.txt
Outdated
| @@ -59,6 +59,18 @@ The 5.0 driver release introduces the following features: | |||
| ``isNumber()`` and ``asNumber()`` methods match the Java responses for | |||
| equivalent ``Decimal128`` values. | |||
|
|
|||
| - The ``getElapsedTime`` method on ``com.mongodb.event.ConnectionReadyEvent`` | |||
There was a problem hiding this comment.
I: In all of our docs that I've seen, we suffix method names with parentheses
Suggested change
| - The ``getElapsedTime`` method on ``com.mongodb.event.ConnectionReadyEvent`` | |
| - The ``getElapsedTime()`` method on ``com.mongodb.event.ConnectionReadyEvent`` |
source/whats-new.txt
Outdated
Comment on lines
64
to
65
| the time returned includes the duration of | ||
| ``com.mongodb.event.ConnectionPoolListener.connectionCreated``. |
There was a problem hiding this comment.
Suggested change
| the time returned includes the duration of | |
| ``com.mongodb.event.ConnectionPoolListener.connectionCreated``. | |
| the time returned includes the duration of the | |
| ``com.mongodb.event.ConnectionPoolListener.connectionCreated()`` method. |
source/whats-new.txt
Outdated
| the time returned includes the duration of | ||
| ``com.mongodb.event.ConnectionPoolListener.connectionCreated``. | ||
|
|
||
| The ``getElapsedTime`` methods on |
There was a problem hiding this comment.
Suggested change
| The ``getElapsedTime`` methods on | |
| The ``getElapsedTime()`` methods on |
source/whats-new.txt
Outdated
Comment on lines
71
to
72
| time returned includes the duration of | ||
| ``com.mongodb.eventConnectionPoolListener.connectionCheckOutStarted``. |
There was a problem hiding this comment.
Suggested change
| time returned includes the duration of | |
| ``com.mongodb.eventConnectionPoolListener.connectionCheckOutStarted``. | |
| time returned includes the duration of the | |
| ``com.mongodb.eventConnectionPoolListener.connectionCheckOutStarted()`` method. |
rachel-mack
force-pushed
the
DOCSP-35270
branch
from
7616b01 to
6b86e2b
Compare
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-35270
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/java/docsworker-xlarge/DOCSP-35270/whats-new/#std-label-version-5.0
Self-Review Checklist