docs(NODE-6516): add documentation for MongoOperationTimeoutError and fix internal references #4315
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
dariakp
requested changes
Nov 5, 2024
etc/notes/errors.md
Outdated
| @@ -111,7 +111,9 @@ This class should **never** be directly instantiated. | |||
|
|
|||
| ### `MongoOperationTimeoutError` | |||
|
|
|||
| - TODO(NODE-6491): Add MongoOperationTimeoutError documentation | |||
| The `MongoOperationTimeoutError` class represents an error that occurs when an operation could not be completed within the specified `timeoutMS`. | |||
| It is generated by the driver in support of the "client side operation timeout" feature so inherits from `MongoDriverError`. | |||
There was a problem hiding this comment.
Suggested change
| It is generated by the driver in support of the "client side operation timeout" feature so inherits from `MongoDriverError`. | |
| It is generated by the driver in support of the "client side operation timeout" feature and inherits from `MongoDriverError`. |
etc/notes/errors.md
Outdated
| - TODO(NODE-6491): Add MongoOperationTimeoutError documentation | ||
| The `MongoOperationTimeoutError` class represents an error that occurs when an operation could not be completed within the specified `timeoutMS`. | ||
| It is generated by the driver in support of the "client side operation timeout" feature so inherits from `MongoDriverError`. | ||
| When `timeoutMS` is enabled `MongoServerErrors` relating to `MaxTimeExpired` errors will be converted to `MongoOperationTimeoutError` |
There was a problem hiding this comment.
Suggested change
| When `timeoutMS` is enabled `MongoServerErrors` relating to `MaxTimeExpired` errors will be converted to `MongoOperationTimeoutError` | |
| When `timeoutMS` is enabled `MongoServerErrors` relating to `MaxTimeExpired` errors will be converted to `MongoOperationTimeoutError`. |
| @@ -28,7 +28,6 @@ import { | |||
| import { type FailPoint, makeMultiBatchWrite, measureDuration } from '../../tools/utils'; | |||
| import { filterForCommands } from '../shared'; | |||
|
|
|||
| // TODO(NODE-5824): Implement CSOT prose tests | |||
There was a problem hiding this comment.
There is a comment that says
'TODO(DRIVERS-2965): see modified test in unified-csot-node-specs', // Skipping for both tailable awaitData and tailable non-awaitData cursors
in client_side_operations_timeout.spec.test.ts - can we remove or update it in this PR?
dariakp
changed the title
nbbeeken
added
the
Primary Review
dariakp
approved these changes
Nov 6, 2024
dariakp
pushed a commit
that referenced
this pull request
Nov 6, 2024
… fix internal references (#4315)
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.
Description
What is changing?
Is there new documentation needed for these changes?
What is the motivation for this change?
Clarity on the error subject
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript