[DOCSP-47795] Change batchsize description #392
Conversation
✅ Deploy Preview for docs-mongodb-shell 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 question and some suggestions for your consideration.
Thanks!
Joe
source/reference/methods.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.
[style suggestion]
Consider wrapping "batchSize" and "0" in backticks here on line 507.
source/reference/methods.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 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, @shuangela! This one LGTM mod a tiny nit.
Thanks,
Joe
source/reference/methods.txt
Outdated
| size is ``101`` documents and subsequent batches have a maximum | ||
| size of 16 mebibytes (MiB). 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 and :method:`~cursor.batchSize()` uses the default batch size. |
There was a problem hiding this comment.
[nit]
Would you mind wrapping this line at col 72? Thanks!
|
@ChrisHarris2012 Thank you for offering to review! |
source/reference/methods.txt
Outdated
| @@ -497,8 +497,17 @@ Cursor Methods | |||
| .. arrayAccess | |||
|
|
|||
| * - :method:`cursor.batchSize()` | |||
| - Controls the number of documents MongoDB will return to the | |||
| client in a single network message. | |||
| - Specifies the maximum number of documents MongoDB will return to the | |||
There was a problem hiding this comment.
How about "can" instead of will? Feels like it aligns better with the interaction with the concurrent size limit
source/reference/methods.txt
Outdated
| has no effect and :method:`~cursor.batchSize()` uses the default | ||
| batch size. |
There was a problem hiding this comment.
'default batch size' here feels... undefined? In general I liked the wording in the other PR about how the batch sizes end up being 'the lesser of the two'
DESCRIPTION
Updates the reference/methods page to clarify how BatchSize works. Related to the batchsize pr in the docs repo. 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-392--docs-mongodb-shell.netlify.app/reference/methods/#cursor-methods
JIRA
https://jira.mongodb.org/browse/DOCSP-47795
BUILD LOG
https://app.netlify.com/sites/docs-mongodb-shell/deploys/67d4525e66989c0008faf1e8
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?