DOCSP-47795 change batchsize descriptions #6292
Conversation
✅ Deploy Preview for mongodb-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for these updates, @shuangela! I've left a few questions and suggestions for your consideration.
Thanks!
Joe
source/reference/command/find.txt
Outdated
| limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results | ||
| in batches larger than 16 MiB, this option has no effect. | ||
| ` | ||
| A batchSize of 0 means that the cursor will be established, but no documents |
There was a problem hiding this comment.
[tense suggestion]
Consider updating this to use the present tense. Spitballing:
A ``batchsize`` of ``0`` means that the cursor is established, but no documents
are returned in the first batch.
Thanks!
source/reference/command/getMore.txt
Outdated
| If ``batchSize`` is not set, ``getMore`` returns up to 16 | ||
| mebibytes of data. If ``batchSize`` is set, ``getMore`` returns | ||
| the smaller of 16 mebibytes of data or ``batchSize`` documents. | ||
| If batchSize is not set, getMore returns up to ``101`` documents in the first batch |
There was a problem hiding this comment.
[style suggestion]
Consider wrapping "batchSize" and "getMore" in backticks here on line 77.
source/reference/command/find.txt
Outdated
| By default, the ``find`` command has an initial batch size of ``101`` documents and a maximum | ||
| size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller | ||
| limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results | ||
| in batches larger than 16 MiB, this option has no effect. |
There was a problem hiding this comment.
[behavior question]
Can we clarify what we mean by "no effect" here? I take it that means it uses the default. Thanks!
There was a problem hiding this comment.
Yes, it means it will use the default, will clarify!
| limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that results | ||
| in batches larger than 16 MiB, this option has no effect. | ||
|
|
||
| A batchSize of 0 means that the cursor will be established, but no documents |
There was a problem hiding this comment.
[tense suggestion]
Consider updating this to use the present tense. Spitballing:
A ``batchsize`` of ``0`` means that the cursor is established, but no documents
are returned in the first batch.
| By default, :method:`~db.collection.watch()` has an initial batch size of ``101`` documents and a maximum size | ||
| of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller | ||
| limit than 16 MiB, but not a larger one. If you set ``batchSize`` to a limit that | ||
| results in batches larger than 16 MiB, this option has no effect. |
There was a problem hiding this comment.
[behavior question]
Can we clarify what we mean by "no effect" here? I take it that means it uses the default.
|
Thanks for the review, @jmd-mongo! Addressed your feedback and applied it to other pages as well, back to you! |
There was a problem hiding this comment.
Thanks for these updates, @shuangela! Would you mind wrapping some of these lines to a shorter width? After that, this one LGTM.
Thanks!
Joe
source/reference/command/find.txt
Outdated
| - Optional. The number of documents to return in the first batch. | ||
| Defaults to 101. A batchSize of 0 means that the cursor will be | ||
| established, but no documents will be returned in the first batch. | ||
| - Optional. The maximum number of documents within each batch returned in a |
There was a problem hiding this comment.
Would you mind wrapping these lines? Thank you! This applies throughout.
|
@ChrisHarris2012 Thank you for offering to review! |
DESCRIPTION
Updates five pages in manual/reference to clarify how BatchSize works. No new sections were added, but descriptions of BatchSize were changed.
Wording taken from already updated PHP driver docs which was approved by a PHP engineer.
STAGING
https://deploy-preview-6292--mongodb-docs.netlify.app/reference/method/cursor.batchSize/
https://deploy-preview-6292--mongodb-docs.netlify.app/reference/command/getMore/
https://deploy-preview-6292--mongodb-docs.netlify.app/reference/command/find/
https://deploy-preview-6292--mongodb-docs.netlify.app/reference/method/db.collection.watch/
https://deploy-preview-6292--mongodb-docs.netlify.app/reference/operator/aggregation/queryStats/#output
JIRA
DOCSP-47795
SELF-REVIEW CHECKLIST
See the taxonomy tagging instructions and this example PR
EXTERNAL REVIEW REQUIREMENTS
What's expected of an external reviewer?