DOCSP-30891: includeResultMetadata option #708
Merged
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
jordan-smith721
approved these changes
Jul 7, 2023
| If you execute each operation separately, another request may alter the | ||
| data between the read and write operations. These data changes may not | ||
| prevent your operation from succeeding, but they can make error handling | ||
| more difficult. When you application has to handle potential errors at |
There was a problem hiding this comment.
Suggested change
| more difficult. When you application has to handle potential errors at | |
| more difficult. When your application has to handle potential errors at |
Comment on lines
25
to
27
| more difficult. When you application has to handle potential errors at | ||
| any stage of the process, your application can become brittle and difficult | ||
| to test. |
There was a problem hiding this comment.
Suggestion: This could be simplified to avoid close repetition of "your application"
Suggested change
| more difficult. When you application has to handle potential errors at | |
| any stage of the process, your application can become brittle and difficult | |
| to test. | |
| more difficult. When your application has to handle potential errors at | |
| any stage of the process, it can become brittle and difficult | |
| to test. |
| - `findOneAndReplace() <{+api+}/classes/Collection.html#findOneAndReplace>`__ | ||
| matches multiple documents to a supplied query and replaces the first | ||
| of those matched documents using the provided replacement document. | ||
|
|
||
| All three methods accept an optional ``options`` object with |
There was a problem hiding this comment.
Suggestion: Remove "three" to make it easier to update in the future if methods are added/removed
Suggested change
| All three methods accept an optional ``options`` object with | |
| These methods accept an optional ``options`` object with |
| configure the ``returnDocument`` option, a boolean that determines if | ||
| the method returns the pre-update or post-update version of the modified | ||
| document. | ||
| :doc:`projection </fundamentals/crud/read-operations/project>` options. |
There was a problem hiding this comment.
Suggestion: Change this to a :ref: if at all possible
There was a problem hiding this comment.
yep - holdover from the first authoring of the page.
mongoKart
pushed a commit
to mongoKart/docs-node
that referenced
this pull request
Nov 3, 2023
* DOCSP-30891: includeResultMetadata option * JS PR fixes
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-30891
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-30891-includeResultMetadata/fundamentals/crud/compound-operations/
Self-Review Checklist