Skip to content

Commit 4b0ba1f

Browse files
authored
DOCSP-36900: Quarterly tasks (mongodb#345)
* DOCSP-36900: Quarterly tasks * more fixes * vale fix * RM feedback * remove info
1 parent fc0137c commit 4b0ba1f

File tree

12 files changed

+31
-31
lines changed

12 files changed

+31
-31
lines changed

Diff for: source/faq.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ following cases:
7070
rate-limits on connection creation.
7171

7272
You can set the minimum number of concurrent connections to
73-
each server with the ``minPoolSize`` option, which defaults to ``0``. The connection pool
74-
will be initialized with this number of sockets. If sockets are closed
75-
due to any network errors, causing the total number of sockets (both in
76-
use and idle) to drop below the minimum, more sockets are opened until
77-
the minimum is reached.
73+
each server by using the ``minPoolSize`` option, which defaults to ``0``.
74+
After setting ``minPoolSize``, the connection pool is initialized with
75+
this number of sockets. If sockets close due to any network errors, causing
76+
the total number of sockets (both in use and idle) to drop below the minimum, more sockets
77+
open until the minimum is reached.
7878

7979
You can set the maximum number of milliseconds that a connection can
8080
remain idle in the pool before being removed and replaced with

Diff for: source/fundamentals/aggregation.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ finished product resembles the **aggregated result**.
3939
Compare Operations
4040
------------------
4141

42-
The following table lists the tasks you can perform with find and aggregation operations.
42+
The following table lists the tasks you can perform by using find and aggregation operations.
4343

4444
.. list-table::
4545
:header-rows: 1
@@ -93,7 +93,7 @@ in the ``tea`` collection:
9393
:dedent:
9494

9595
To run the examples in this section, load the sample data into the
96-
``tea`` collection in the ``db`` database with the following snippet:
96+
``tea`` collection in the ``db`` database by using the following snippet:
9797

9898
.. literalinclude:: /includes/fundamentals/code-snippets/aggregation.go
9999
:start-after: begin insert docs

Diff for: source/fundamentals/auth.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type . To configure these options, pass a ``Credential`` type to the
4545
method of the `ClientOptions <{+api+}/mongo/options#ClientOptions>`__
4646
type.
4747

48-
The following sections demonstrate this process with the five
48+
The following sections demonstrate this process by using the five
4949
mechanisms the MongoDB Community Edition supports.
5050

5151
Example Conventions
@@ -149,7 +149,7 @@ To specify the ``SCRAM-SHA-256`` authentication mechanism, assign the
149149
3.0, 3.2, 3.4, and 3.6.
150150

151151
``SCRAM-SHA-1`` is a salted challenge-response mechanism (SCRAM) that uses your
152-
username and password, encrypted with the ``SHA-1`` algorithm, to authenticate
152+
username and password, encrypted using the ``SHA-1`` algorithm, to authenticate
153153
your user.
154154

155155
To specify the ``SCRAM-SHA-1`` authentication mechanism, assign the

Diff for: source/fundamentals/bson.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The {+driver-short+} provides four main types for working with BSON data:
4343
- ``E``: A single element inside a D type
4444

4545
The following example demonstrates how to construct a query filter by using the
46-
``bson.D`` type to match documents with a ``quantity`` field value greater
46+
``bson.D`` type to match documents in which the ``quantity`` field value is greater
4747
than 100:
4848

4949
.. code-block:: go

Diff for: source/fundamentals/collations.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Specify a Collation
5858

5959
To specify a collation, create a ``Collation`` object. You must define the ``Locale`` field
6060
of the ``Collation`` object; all other fields are optional. For example, the following code
61-
snippet specifies a ``Collation`` object with the ``"en_US"`` locale collation:
61+
example specifies a ``Collation`` object with the ``"en_US"`` locale collation:
6262

6363
.. code-block:: go
6464

@@ -100,7 +100,7 @@ Use the Default Collation Example
100100
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101101

102102
If you call an operation that uses a collation on the ``books`` collection, the operation
103-
will now use the default collation specified in the :ref:`golang-create-collection`.
103+
uses the default collation specified in the :ref:`golang-create-collection`.
104104

105105
Assume the ``books`` collection contains the following documents:
106106

@@ -173,8 +173,8 @@ doesn't perform the ordering for sorting operations in-memory.
173173

174174
To use the index in an operation, your operation must use the same collation as the one
175175
specified in the index. Additionally, ensure that the operation is covered by the index that
176-
contains the collation. Set a collation through an ``IndexOptions`` object and call the
177-
``CreateOne()`` method with your options object as an argument.
176+
contains the collation. Set a collation through an ``IndexOptions`` object and pass this object
177+
as an argument to the ``CreateOne()`` method.
178178

179179
Example
180180
~~~~~~~
@@ -234,8 +234,8 @@ Example
234234
You can use operations that support collation to update and query documents in the
235235
``books`` collection.
236236

237-
The following example uses the ``Find()`` method to return documents with ``length``
238-
values greater than ``"1000"``. The ``NumericOrdering`` collation field has a value of
237+
The following example uses the ``Find()`` method to return documents in which the ``length``
238+
value is greater than ``"1000"``. The ``NumericOrdering`` collation field has a value of
239239
``true`` to ensure that values are sorted in numerical order rather than alphabetical
240240
order:
241241

Diff for: source/fundamentals/crud/read-operations/changestream.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ in the ``courses`` collection:
3939
:dedent:
4040

4141
To run the examples in this guide, load these documents into the
42-
``courses`` collection in the ``db`` database with the following snippet:
42+
``courses`` collection in the ``db`` database by using the following snippet:
4343

4444
.. literalinclude:: /includes/fundamentals/code-snippets/CRUD/changeStream.go
4545
:language: go
@@ -77,7 +77,7 @@ outputs all changes:
7777
:start-after: begin open stream
7878
:end-before: end open stream
7979

80-
If you modify the ``courses`` collection in a separate program or shell, this code will print
80+
If you modify the ``courses`` collection in a separate program or shell, this code prints
8181
your changes as they occur. Inserting a document with a ``title`` value
8282
of ``"Advanced Screenwriting"`` and an ``enrollment`` value of ``20``
8383
results in the following change event:

Diff for: source/fundamentals/crud/read-operations/retrieve.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ in the ``tea`` collection:
3636
:dedent:
3737

3838
To run the examples in this guide, load these documents into the
39-
``tea`` collection in the ``db`` database with the following snippet:
39+
``tea`` collection in the ``db`` database by using the following snippet:
4040

4141
.. literalinclude:: /includes/fundamentals/code-snippets/CRUD/retrieve.go
4242
:language: go

Diff for: source/fundamentals/crud/read-operations/sort.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ the following documents:
175175
{"title":"Plate Tectonics","enrollment":35}
176176

177177
You can sort on additional fields to resolve ties in the original sort.
178-
If you want to guarantee a specific order for documents, you should
179-
select sort fields that will not result in additional ties.
178+
If you want to guarantee a specific order for documents, select sort fields
179+
that do not result in ties.
180180

181181
Example
182182
```````

Diff for: source/fundamentals/geo.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ queries:
184184
~~~~~~~~
185185
To query data stored in the GeoJSON format, add the field containing
186186
both the ``type`` and ``coordinates`` to a ``2dsphere`` index. The
187-
following snippet creates a ``2dsphere`` index on the ``location`` field:
187+
following example creates a ``2dsphere`` index on the ``location`` field:
188188

189189
.. code-block:: go
190190

@@ -201,7 +201,7 @@ following snippet creates a ``2dsphere`` index on the ``location`` field:
201201
2d
202202
~~
203203
To query data stored as legacy coordinate pairs, you must add the field containing
204-
legacy coordinate pairs to a ``2d`` index. The following snippet creates a
204+
legacy coordinate pairs to a ``2d`` index. The following example creates a
205205
``2d`` index on the ``coordinates`` field:
206206

207207
.. code-block:: go

Diff for: source/fundamentals/logging.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ This example demonstrates how to define and implement a custom logger.
249249

250250
.. note::
251251

252-
The preceding code snippet uses a ``Mutex`` type in the
252+
The preceding code example uses a ``Mutex`` type in the
253253
``CustomLogger`` struct to ensure atomic writes and prevent
254254
race conditions. Setting a ``Mutex`` makes your logger safe for
255255
concurrent use by multiple goroutines.

Diff for: source/quick-start.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Quick Start
1717
Set up Your Project
1818
-------------------
1919

20-
Initialize with Go Mod
21-
~~~~~~~~~~~~~~~~~~~~~~
20+
Use Go Mod to Initialize a Project
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2222

23-
Create a new directory and initialize your project with ``go mod``.
23+
Create a new directory and initialize your project by using ``go mod``.
2424

2525
.. code-block:: shell
2626

@@ -64,9 +64,9 @@ Next, create a file to contain your application called ``main.go``
6464
in the base directory of your project. Use the following sample
6565
code to run a query on your sample dataset in MongoDB Atlas.
6666

67-
Set the value of the ``uri`` variable with your MongoDB Atlas connection
68-
string, or create an environment variable with the name ``MONGODB_URI``
69-
with your Atlas connection string.
67+
Specify your MongoDB Atlas connection string as the value of the
68+
``uri`` variable, or create an environment variable called
69+
``MONGODB_URI`` and set your Atlas connection string as its value.
7070

7171
.. code-block:: bash
7272

Diff for: source/usage-examples.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Environment Variable
6464
~~~~~~~~~~~~~~~~~~~~
6565

6666
To connect the example to your MongoDB instance, you must :ref:`define
67-
an environment variable <golang-usage-examples-env-variable>` with
67+
an environment variable <golang-usage-examples-env-variable>` by using
6868
your connection string.
6969

7070
.. code-block:: go

0 commit comments

Comments
 (0)