Skip to content

docs(NODE-6456): document CSOT pt 1 #4292

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

Merged
merged 11 commits into from
Nov 1, 2024
Merged

Conversation

W-A-James
Copy link
Contributor

@W-A-James W-A-James commented Oct 24, 2024

Description

What is changing?

  • Add API docs to timeoutMS and timeoutMode options
  • Add API docs to CursorTimeoutMode
  • Make timeoutMS and timeoutMode public
Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@W-A-James W-A-James changed the title start API docs docs(NODE-6456): document CSOT Oct 24, 2024
@W-A-James W-A-James changed the title docs(NODE-6456): document CSOT docs(NODE-6456): document CSOT pt 1 Oct 24, 2024
@W-A-James
Copy link
Contributor Author

Question: Did we want to mark the CSOT options as public or as experimental for the release?

@W-A-James W-A-James marked this pull request as ready for review October 28, 2024 19:57
@nbbeeken nbbeeken self-assigned this Oct 30, 2024
@nbbeeken nbbeeken added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Oct 30, 2024
@nbbeeken nbbeeken self-requested a review October 30, 2024 21:42
@nbbeeken nbbeeken added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Oct 31, 2024
Copy link
Contributor

@nbbeeken nbbeeken left a comment

Choose a reason for hiding this comment

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

LGTM!

I just fixed a bit of formatting: public tags on a new line, example tags directly proceed code snippets.

I also fixed our timeoutMode enum not exported from the top-level index file, and added "type" exports to 'AnyBulkWriteOperation', 'BulkWriteOptions' which fix an outstanding erroneous issue where when loaded with ts-node those appear as "undefined" exports.

The diff on the EXPECTED_EXPORTS may look strange, I alphabetized it to make 👁️ eye inspection a bit easier.

@aditi-khare-mongoDB
Copy link
Contributor

Also, let's add in the @experimental tag in instead of @public

Copy link
Contributor

@aditi-khare-mongoDB aditi-khare-mongoDB left a comment

Choose a reason for hiding this comment

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

Thanks for your quick response on this PR! I think there's a few more missing @experimental tags and I asked for a some more clarification on the index.test.ts changes

@aditi-khare-mongoDB aditi-khare-mongoDB merged commit 26d0e8e into NODE-6090 Nov 1, 2024
1 check was pending
@aditi-khare-mongoDB aditi-khare-mongoDB deleted the NODE-6456 branch November 1, 2024 18:48
nbbeeken added a commit that referenced this pull request Nov 5, 2024
Co-authored-by: Neal Beeken <[email protected]>
Co-authored-by: Aditi Khare <[email protected]>
dariakp pushed a commit that referenced this pull request Nov 6, 2024
Co-authored-by: Neal Beeken <[email protected]>
Co-authored-by: Aditi Khare <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants