Skip to content
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

DOCSP-4466 Add CSOT #951

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

stephmarie17
Copy link
Collaborator

@stephmarie17 stephmarie17 commented Dec 13, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44666
Staging - https://deploy-preview-951--docs-node.netlify.app/fundamentals/connection/csot/

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Dec 14, 2024

Deploy Preview for docs-node ready!

Name Link
🔨 Latest commit 1ed5035
🔍 Latest deploy log https://app.netlify.com/sites/docs-node/deploys/677daa59243a0c0008bf2b04
😎 Deploy Preview https://deploy-preview-951--docs-node.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@stephmarie17 stephmarie17 marked this pull request as ready for review December 18, 2024 17:25
Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall good, thanks for taking this! Some suggestions for clarity and small fixes. I'll be back Jan 7, but Mike says he is available for re-review if you want it back a little sooner. Have a great holiday break!

source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/code-snippets/connection/csot.js Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lots of comments, but they're all small. great work!

source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
@stephmarie17 stephmarie17 requested a review from mongoKart January 6, 2025 22:03
Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a couple small things but otherwise LGTM

source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
source/fundamentals/connection/csot.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small comments and fix, great work on this! LGTM :)

Overview
--------

When you use {+driver-short+} to perform a server operation, you can also limit
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you use {+driver-short+} to perform a server operation, you can also limit
When you use the {+driver-short+} to perform a server operation, you can also limit

S: I think we normally put 'the' in front of the the driver name!

specify a **client-side operation timeout (CSOT)**. The timeout applies to all steps
needed to complete the operation, including server selection, connection
checkout, serialization, and server-side execution. When the timeout expires,
{+driver-short+} raises a timeout exception.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{+driver-short+} raises a timeout exception.
the {+driver-short+} raises a timeout exception.

the

~~~~~~~~~~~~~~~~~~~

When you specify a ``timeoutMS`` option, the driver applies the timeout
according to the same inheritance behaviors as other {+driver-short+} options.
Copy link
Collaborator

@lindseymoore lindseymoore Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
according to the same inheritance behaviors as other {+driver-short+} options.
according to the same inheritance behaviors as the other {+driver-short+} options.

S: Could put 'the' here as well, since you're talking about a specific set of options mentioned previously

``getMore()`` method must finish within the limit specified by the ``timeoutMS``
option. If they do not, the system throws a timeout error.

When you close a cursor by calling the ``toArray()``or ``close()`` method, the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you close a cursor by calling the ``toArray()``or ``close()`` method, the
When you close a cursor by calling the ``toArray()`` or ``close()`` method, the

I: The space fixes the formatting on the page!

Comment on lines +208 to +210
As shown in the following example, the cursor continues to fetch new documents
as they are added to a collection, and then times out if it takes longer than 10
seconds to retrieve documents:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As shown in the following example, the cursor continues to fetch new documents
as they are added to a collection, and then times out if it takes longer than 10
seconds to retrieve documents:
As shown in the following example, the cursor continues to fetch new documents
as they are added to a collection and times out if it takes longer than 10
seconds to retrieve documents:

S: Don't think that second clause is independent, so I removed the comma and 'then'. Could also separate into two sentences.
Style Guide on 'then' : https://www.mongodb.com/docs/meta/style-guide/terminology/alphabetical-terms/#t

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants