DOCSP-33952: Atomic typos #319
Merged
Conversation
This file contains 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
rustagir
approved these changes
Nov 15, 2023
source/fundamentals/auth.txt
Outdated
| @@ -261,7 +261,7 @@ they are listed: | |||
|
|
|||
| .. note:: | |||
|
|
|||
| If you don't need an AWS session token for the role you're | |||
| If you don't require an AWS session token for the role you're | |||
| authenticating with, omit the line containing ``AWS_SESSION_TOKEN`` . | |||
There was a problem hiding this comment.
S: remove extra space here
Suggested change
| authenticating with, omit the line containing ``AWS_SESSION_TOKEN`` . | |
| authenticating with, omit the line containing ``AWS_SESSION_TOKEN``. |
source/fundamentals/collations.txt
Outdated
| an ordered representation of the documents in the collection so your MongoDB instance | ||
| does not need to perform the ordering for sorting operations in-memory. | ||
| an ordered representation of the documents in the collection, so your MongoDB instance | ||
| does not perform the ordering for sorting operations in-memory. |
There was a problem hiding this comment.
S: keep a less formal tone
Suggested change
| does not perform the ordering for sorting operations in-memory. | |
| doesn't perform the ordering for sorting operations in-memory. |
source/fundamentals/context.txt
Outdated
| @@ -78,10 +83,10 @@ out a connection, the method returns a timeout error. | |||
| Connection Establishment | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| The driver might block an method call if it needs to create a new | |||
| The driver might block an method call if it must create a new | |||
There was a problem hiding this comment.
Suggested change
| The driver might block an method call if it must create a new | |
| The driver might block a method call if it must create a new |
source/fundamentals/context.txt
Outdated
Comment on lines
89
to
90
| When the driver must create a new connection to execute an | ||
| operation, the Context sets a timeout for the establishment process. The |
There was a problem hiding this comment.
S: must is unnecessary here
Suggested change
| When the driver must create a new connection to execute an | |
| operation, the Context sets a timeout for the establishment process. The | |
| When the driver creates a new connection to perform an | |
| operation, the Context sets a timeout for the establishment process. The |
Comment on lines
34
to
35
| If you must read and write to more than one document, use | ||
| :ref:`transactions <golang-transactions>`. |
There was a problem hiding this comment.
S: change sentence
Suggested change
| If you must read and write to more than one document, use | |
| :ref:`transactions <golang-transactions>`. | |
| To learn how to perform compound operations on more than one document | |
| at a time, see the :ref:`Transactions <golang-transactions>` guide. |
Comment on lines
82
to
83
| To find and delete a document in separate transactions, call the | ||
| ``findOne()`` method followed by the ``deleteOne()`` method. |
There was a problem hiding this comment.
S: something about this sentence is awkward, separate
Suggested change
| To find and delete a document in separate transactions, call the | |
| ``findOne()`` method followed by the ``deleteOne()`` method. | |
| To find a document and delete it in separate operations, call the | |
| ``findOne()`` method followed by the ``deleteOne()`` method. |
Comment on lines
171
to
172
| To find and update a document in separate transactions, call | ||
| the ``findOne()`` method followed by the ``updateOne()`` method. |
| the ``InsertOne()`` method, or insert multiple documents using either | ||
| the ``InsertMany()`` or ``BulkWrite()`` method. | ||
| Before you can find, update, and delete documents in MongoDB, you must | ||
| insert those documents. You can insert one document using the ``InsertOne()`` |
There was a problem hiding this comment.
Suggested change
| insert those documents. You can insert one document using the ``InsertOne()`` | |
| insert those documents. You can insert one document by using the ``InsertOne()`` |
| the ``InsertMany()`` or ``BulkWrite()`` method. | ||
| Before you can find, update, and delete documents in MongoDB, you must | ||
| insert those documents. You can insert one document using the ``InsertOne()`` | ||
| method, or insert multiple documents using either the ``InsertMany()`` |
There was a problem hiding this comment.
Suggested change
| method, or insert multiple documents using either the ``InsertMany()`` | |
| method, or insert multiple documents by using either the ``InsertMany()`` |
| @@ -22,5 +22,5 @@ If your MongoDB Server is running locally, you can use the connection string | |||
| ``"mongodb://localhost:<port>"`` where ``<port>`` is the port number you | |||
| configured your server to listen for incoming connections. | |||
|
|
|||
| If you need to specify a different hostname or IP address, see our Server | |||
| If you must specify a different hostname or IP address, see our Server | |||
There was a problem hiding this comment.
S: here, I think "want to" is more apt
Suggested change
| If you must specify a different hostname or IP address, see our Server | |
| If you want to specify a different hostname or IP address, see our Server |
norareidy
added a commit
that referenced
this pull request
Nov 15, 2023
* DOCSP-33952: Atomic typos * tagging * style guide edits * more tagging * vale * RR feedback (cherry picked from commit 9b44ddd)
norareidy
added a commit
that referenced
this pull request
Nov 15, 2023
* DOCSP-33952: Atomic typos * tagging * style guide edits * more tagging * vale * RR feedback (cherry picked from commit 9b44ddd)
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-33952
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/golang/DOCSP-33952-atomic-typos/
Self-Review Checklist