Skip to content

DOCSP-29676 v5.4 update #675

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

Conversation

jordan-smith721
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-29676
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-29676-v5.4-release/

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?

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.

good job. tiny things


.. important:: Deprecation Notice

- The ``collStats`` helper is deprecated. Use the :manual:`$collStats
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: Looking at the JIRA ticket, collStats is a helper command. Might be useful to specify here.

Suggested change
- The ``collStats`` helper is deprecated. Use the :manual:`$collStats
- The ``collStats`` helper command is deprecated. Use the :manual:`$collStats

Comment on lines 50 to 51
- Methods of ``db.command()`` that were incorrectly included in the
typescript interface have been deprecated.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I: I think these were options, not methods.

Suggested change
- Methods of ``db.command()`` that were incorrectly included in the
typescript interface have been deprecated.
- The TypeScript interface passed to the ``db.command()`` method incorrectly
includes certain options. These options have been deprecated.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oops, good catch. Changed

- Methods of ``db.command()`` that were incorrectly included in the
typescript interface have been deprecated.

- The ``ChangeStream.tryNext`` method now uses the ``TChange`` schema
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
- The ``ChangeStream.tryNext`` method now uses the ``TChange`` schema
- The ``ChangeStream.tryNext()`` method now uses the ``TChange`` schema

Comment on lines 53 to 54
- The ``ChangeStream.tryNext`` method now uses the ``TChange`` schema
generic instead of the untyped ``Document`` interface.
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: Something like:

Suggested change
- The ``ChangeStream.tryNext`` method now uses the ``TChange`` schema
generic instead of the untyped ``Document`` interface.
- The ``ChangeStream.tryNext`` method now uses the schema-specific
``TChange`` generic type instead of the ``Document`` interface.

@jordan-smith721 jordan-smith721 requested a review from mongoKart May 4, 2023 22:22
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.

lgtm!

@jordan-smith721 jordan-smith721 merged commit 39435a5 into mongodb:master May 5, 2023
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
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.

2 participants