Skip to content

Commit 444ad8c

Browse files
authored
DOCSP-33948: Atomic typos and cleanup (#829)
* DOCSP-33948: Atomic typos and cleanup * tagging * vale * vale fix * edit * MW re-review * vale
1 parent 5b99195 commit 444ad8c

20 files changed

+139
-70
lines changed

source/connection-troubleshooting.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Connection Troubleshooting
55
==========================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, node.js, disconnected, help
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -283,7 +290,7 @@ The following section describes a method that may help resolve the issue.
283290
Check the Number of Connections
284291
-------------------------------
285292

286-
If you need to create more open connections, increase ``maxPoolSize``. For more
293+
To create more open connections, increase the value of ``maxPoolSize``. For more
287294
information about checking the number of connections, see
288295
:ref:`Check the Number of Connections <node-troubleshooting-connection-number-connections>`
289296
in the Error Sending Message section.

source/faq.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ What Is the Difference Between "connectTimeoutMS", "socketTimeoutMS" and "maxTim
135135
have already been connected.
136136
* - **maxTimeMS**
137137
- `maxTimeMS <{+api+}/classes/FindCursor.html#maxTimeMS>`__
138-
specifies the maximum amount of time the server
139-
should wait for an operation to complete after it has reached the
138+
specifies the maximum amount of time that the server
139+
waits for an operation to complete after it has reached the
140140
server. If an operation runs over the specified time limit, it
141141
returns a timeout error. You can pass ``maxTimeMS`` only to an
142142
individual operation or to a cursor.
@@ -339,8 +339,8 @@ The connection string passed to the driver must use exact hostnames for
339339
the servers as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.
340340
Given the following configuration settings for your Replica Set, in
341341
order for the Replica Set discovery and :manual:`failover
342-
</reference/glossary/#term-failover>` to work the driver should be able
343-
to reach ``server1``, ``server2``, and ``server3``.
342+
</reference/glossary/#term-failover>` to work, the driver must have access
343+
to ``server1``, ``server2``, and ``server3``.
344344

345345
.. code-block:: JSON
346346

source/fundamentals/connection/connection-options.txt

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Connection Options
55
==================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: node.js, customize
13+
714
This section explains the MongoDB connection and authentication options
815
supported by the driver. You can pass the connection options as
916
parameters of the connection URI to specify the behavior of the client.
@@ -44,7 +51,7 @@ parameters of the connection URI to specify the behavior of the client.
4451
* - **authSource**
4552
- string
4653
- ``null``
47-
- Specifies the database that connections should authenticate against.
54+
- Specifies the database that connections authenticate against.
4855

4956
* - **compressors**
5057
- comma separated list of strings, for example, "snappy,zlib,zstd"
@@ -118,8 +125,8 @@ parameters of the connection URI to specify the behavior of the client.
118125
* - **minPoolSize**
119126
- non-negative integer
120127
- ``0``
121-
- Specifies the number of connections the driver should create and
122-
maintain in the connection pool even when no operations are occurring.
128+
- Specifies the number of connections the driver creates and
129+
maintains in the connection pool even when no operations are occurring.
123130
This count includes connections in use.
124131

125132
* - **proxyHost**
@@ -246,17 +253,16 @@ parameters of the connection URI to specify the behavior of the client.
246253
* - **tlsAllowInvalidCertificates**
247254
- boolean
248255
- ``false``
249-
- Specifies whether the driver should error when the servers
250-
TLS certificate is invalid. You should only set this option to
251-
``true`` for testing purposes.
256+
- Specifies whether the driver generates an error when the server's
257+
TLS certificate is invalid. Set this option to ``true`` for testing
258+
purposes only.
252259

253260
* - **tlsAllowInvalidHostnames**
254261
- boolean
255262
- ``false``
256-
- Specifies whether the driver should error when there is a mismatch
257-
between the server’s hostname and the hostname specified by the
258-
TLS certificate. You should only set this option to
259-
``true`` for testing purposes.
263+
- Specifies whether the driver generates an error when there is a mismatch
264+
between the server's hostname and the hostname specified by the
265+
TLS certificate. Set this option to ``true`` for testing purposes only.
260266

261267
* - **tlsCAFile**
262268
- string
@@ -285,8 +291,8 @@ parameters of the connection URI to specify the behavior of the client.
285291
- boolean
286292
- ``false``
287293
- Specifies to relax TLS constraints as much as possible, such as
288-
allowing invalid certificates or hostname mismatches. You should
289-
only set this option to ``true`` for testing purposes.
294+
allowing invalid certificates or hostname mismatches. Set this option
295+
to ``true`` for testing purposes only.
290296

291297
* - **w**
292298
- non-negative integer or string

source/fundamentals/connection/tls.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Enable TLS on a Connection
55
==========================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, node.js, security, encrypt
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -101,7 +108,7 @@ files.
101108
certificates generated and signed by the same certificate authority.
102109
For testing, you can use self-signed certificates.
103110

104-
The following list describes the components that you need to establish
111+
The following list describes the components required to establish
105112
a connection with TLS:
106113

107114
.. list-table::

source/fundamentals/crud/compound-operations.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Compound Operations
55
===================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: node.js, atomic operation, read, write
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -13,9 +20,9 @@ Compound Operations
1320
Overview
1421
--------
1522

16-
Most database requests need to either read data out of a database or
17-
write data into a database. However, there are instances where you may
18-
need to read and write data in a single interaction.
23+
Most database requests either read data from a database or write data into
24+
a database. However, there are instances where you may require a single
25+
operation that reads and writes data.
1926

2027
**Compound operations** combine read and write operations
2128
in a single atomic statement, so there's no chance of data changing in

source/fundamentals/crud/read-operations/geo.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Legacy coordinate pairs use the following structure:
8080

8181
<field> : [ x, y ]
8282

83-
The field should contain an array of two values in which the first represents
83+
The field contains an array of two values in which the first represents
8484
the ``x`` axis value and the second represents the ``y`` axis value.
8585

8686
To enable querying using legacy coordinate pairs, create a ``2d`` index on

source/fundamentals/crud/read-operations/project.txt

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,11 @@ field of each document:
7070
console.dir(doc);
7171
}
7272

73-
The projection document specifies a value of ``1`` for ``name`` to
74-
indicate that the read operation result should *include* the ``name``
75-
field of each returned document. As a result, this projection implicitly
76-
excludes the ``qty`` and ``rating`` fields. Passing this projection to
77-
``find()`` with an empty query document and no sort document yields
78-
the following results:
73+
The projection document specifies a value of ``1`` for ``name``. This instructs
74+
the operation to *include* the ``name`` field of each returned document in
75+
the results and *exclude* the ``qty`` and ``rating`` fields. Passing this projection
76+
to ``find()`` with an empty query document and no sort document yields the following
77+
results:
7978

8079
.. code-block:: json
8180
:copyable: false
@@ -110,12 +109,11 @@ returned documents.
110109
console.dir(doc);
111110
}
112111

113-
The projection document specifies a value of ``1`` for ``name`` to
114-
indicate that the read operation result should *include* the ``name``
115-
field of each returned document. As a result, this projection implicitly
116-
excludes the ``qty`` and ``rating`` fields. Passing this projection to
117-
``find()`` with an empty query document and no sort document yields
118-
the following results:
112+
The projection document specifies a value of ``1`` for ``name`` and ``0`` for
113+
``_id``. This instructs the operation to *include* the ``name`` field of each
114+
returned document in the results and *exclude* the ``_id``, ``qty``, and ``rating``
115+
fields. Passing this projection to ``find()`` with an empty query document and
116+
no sort document yields the following results:
119117

120118
.. code-block:: json
121119
:copyable: false

source/fundamentals/crud/write-operations/insert.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Insert Documents
55
================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, node.js, add data
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -18,7 +25,7 @@ In this guide, you can learn how to insert documents into MongoDB.
1825
You can use MongoDB to retrieve, update and delete information. To
1926
perform any of those operations, that information, such as user profiles
2027
and orders, needs to exist in MongoDB. For that information to exist,
21-
you need to first perform an **insert operation**.
28+
you must first perform an **insert operation**.
2229

2330
An insert operation inserts one or more documents into a MongoDB collection.
2431
The {+driver-short+} provides the following methods to perform insert

source/fundamentals/crud/write-operations/upsert.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Insert or Update in a Single Operation
55
======================================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, node.js, write, add data
813

914
.. contents:: On this page
1015
:local:
@@ -16,8 +21,8 @@ Overview
1621
--------
1722

1823
If your application stores and modifies data in MongoDB, you probably use
19-
insert and update operations. In certain workflows, you may need to choose
20-
between an insert and update depending on whether the document exists.
24+
insert and update operations. In certain workflows, whether you perform
25+
an insert or update operation depends on whether the document exists.
2126
In these cases, you can streamline your application logic by using the
2227
``upsert`` option available in the following methods:
2328

@@ -69,7 +74,7 @@ Performing an Upsert
6974

7075
Consider the case in which you want to add information about the food
7176
truck even if it does not currently exist in your collection. Rather than
72-
first querying whether it exists to determine whether we need to insert or
77+
first querying whether it exists to determine whether to insert or
7378
update the document, we can set ``upsert`` to ``true`` in our call to
7479
``updateOne()`` as follows:
7580

source/fundamentals/monitoring/cluster-monitoring.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@
44
Cluster Monitoring
55
==================
66

7-
.. default-domain:: mongodb
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, node.js, watch
813

914
.. contents:: On this page
1015
:local:
@@ -22,8 +27,8 @@ a change in the state of the instance or cluster that you connected to.
2227
For example, the driver creates an event when you establish a new connection
2328
or if the cluster elects a new primary.
2429

25-
Read this guide if you need to record topology changes in your application or
26-
want to explore the information provided in these events.
30+
The following sections demonstrate how to record topology changes in your application
31+
and explore the information provided in these events.
2732

2833
Event Subscription Example
2934
--------------------------

0 commit comments

Comments
 (0)