DOCSP-36851: fy2025q1 typos #113
Conversation
| @@ -52,8 +52,8 @@ The _id Field | |||
| In MongoDB, each document *must* contain a unique ``_id`` field. | |||
| MongoDB allows you to manage this field in the following ways: | |||
|
|
|||
| - Manage this field yourself, ensuring that each ``_id`` value you set | |||
| is unique. | |||
| - Manually create values for this field in your application, ensuring | |||
There was a problem hiding this comment.
Suggestion:
While this isn't in the scope of the ticket, I think it would be helpful to mention that the driver automatically generates it before letting the reader know that they can manually assign it.
I think that info could be presented in the second sentence of the paragraph and that overriding the behavior should be listed as an alternative since automatic generation is recommended and is a special case that probably only a small percentage of users need to know about.
I also think the first sentence could be more specific since the uniqueness applies to collections (you can use the same _id value in a document in a different collection).
E.g.
"In a MongoDB collection, each document must ... The driver automatically generates a unique value as an ObjectId type.
If you must use a custom _id value, assign it in the documents passed to your insert operation. Make sure the value is unique because ..."
| @@ -146,7 +146,7 @@ You can access cursor results as a stream to retrieve individual documents | |||
| or collect multiple documents at once. | |||
|
|
|||
| The ``Cursor`` type implements the ``Stream`` trait, so you can iterate | |||
| through the cursor as a stream. This pattern may help you write more | |||
| through the cursor as a stream. This pattern might help you write more | |||
There was a problem hiding this comment.
Suggestion:
No change needed, but I think this could be made more direct by using the following wording: "You can use this pattern to help you write more"
source/whats-new.txt
Outdated
| experiencing network connectivity issues. It also performs retries on a | ||
| greater range of error types encountered. | ||
| The driver avoids retrying network connections for ``mongos`` backend | ||
| configurations experiencing network connectivity issues. It also |
There was a problem hiding this comment.
Issue:
-
I think this update attributes the configurations as experiencing network connectivity issues rather than the mongos instances.
-
I think the sentence that follows this contains a pronoun "it" that could be interpreted as related to mongos.
Suggestion:
I think this could be reworded to be more concise and attribute the network connectivity issues to the mongos instances. I think reordering the sentences as follows could be helpful in separating the context:
[This driver version...]
"Improves network connectivity and operation reliability."
"The driver performs retries on a greater range of error types it encounters."
"The driver also avoids retries for mongos instances experiencing network connectivity issues."
(cherry picked from commit 2bd705b)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-36851
Staging - https://preview-mongodbrustagir.gatsbyjs.io/rust/DOCSP-36851-fy2025q1-typos/
Self-Review Checklist