Skip to content

DOCSP-36851: fy2025q1 typos #113

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
merged 4 commits into from
Feb 16, 2024

Conversation

rustagir
Copy link
Collaborator

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

  • 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?
  • Are the facets and meta keywords accurate?

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM, good catches! A couple suggestions and issue. If they increase the scope of the change too much, feel free to ticket them.

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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"

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Issue:

  1. I think this update attributes the configurations as experiencing network connectivity issues rather than the mongos instances.

  2. 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."

@rustagir rustagir merged commit 2bd705b into mongodb:master Feb 16, 2024
rustagir added a commit that referenced this pull request Feb 16, 2024
(cherry picked from commit 2bd705b)
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