Skip to content

Commit 34bacd6

Browse files
authored
[Node.js] Style guide fixes for TDBX vale rules (#842)
* apply vale rules
1 parent c2fb128 commit 34bacd6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+215
-247
lines changed

source/connection-troubleshooting.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ using the {+driver-long+} to connect to a MongoDB deployment.
2929
{+driver-short+}
3030
- The :ref:`Issues & Help <node-issues-help>` page, which has
3131
information about reporting bugs, contributing to the driver, and
32-
finding additional resources
32+
finding more resources
3333
- The `MongoDB Community Forums <https://community.mongodb.com>`__ for
3434
questions, discussions, or general technical support
3535

@@ -139,8 +139,7 @@ file descriptor limit in your operating system.
139139

140140
.. warning::
141141

142-
Changing the configuration of your operating system should always be done
143-
with caution.
142+
Always be cautious when changing the configuration of your operating system.
144143

145144
Authentication Error
146145
~~~~~~~~~~~~~~~~~~~~
@@ -320,8 +319,8 @@ time the driver spends attempting to establish the connection by using the
320319
:manual:`Timeout Options </reference/connection-string/#timeout-options>` in
321320
the Server manual.
322321

323-
You should ensure the ``connectTimeoutMS`` setting is not lower than
324-
the highest network latency you have to a member of the set. If one of the
322+
Ensure the ``connectTimeoutMS`` setting is not lower than
323+
the highest network latency you have for a member of the set. If one of the
325324
secondary members has a latency of 10000 milliseconds, setting the
326325
``connectTimeoutMS`` to 9000 prevents the driver from ever connecting to that
327326
member.

source/faq.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ the value of ``maxPoolSize``, the next request to that server will wait
4040
until a connection becomes available.
4141

4242
In addition to the sockets needed to support your application's requests,
43-
each ``MongoClient`` instance opens two additional sockets per server
43+
each ``MongoClient`` instance opens two more sockets per server
4444
in your MongoDB topology for monitoring the server's state.
4545
For example, a client connected to a three-node replica set opens six
4646
monitoring sockets. If the application uses the default setting for
@@ -187,7 +187,7 @@ driver correctly closed the corresponding socket.
187187
To make sure that the driver correctly closes the socket in these cases,
188188
set the ``socketTimeoutMS`` option. When a MongoDB process times out, the driver
189189
will close the socket. We recommend that you select a value
190-
for ``socketTimeoutMS`` that is two to three times as long as the
190+
for ``socketTimeoutMS`` that is two to three times longer than the
191191
expected duration of the slowest operation that your application executes.
192192

193193
How Can I Prevent Sockets From Timing Out Before They Become Active?

source/fundamentals/aggregation.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ assembles the initial parts and materials into finished products.
3636
The **aggregation pipeline** is the assembly line, **aggregation stages** are the assembly stations, and
3737
**operator expressions** are the specialized tools.
3838

39-
Aggregation vs. Query Operations
40-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39+
Comparing Aggregation and Query Operations
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4141

4242
Using query operations, such as the ``find()`` method, you can perform the following actions:
4343

@@ -58,9 +58,9 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
5858
- Returned documents must not violate the :manual:`BSON-document size limit </reference/limits/#mongodb-limit-BSON-Document-Size>`
5959
of 16 megabytes.
6060

61-
- Pipeline stages have a memory limit of 100 megabytes by default. If necessary, you may exceed this limit by setting the ``allowDiskUse``
62-
property of ``AggregateOptions`` to ``true``. See the
63-
`AggregateOptions API documentation <{+api+}/interfaces/AggregateOptions.html>`__
61+
- Pipeline stages have a memory limit of 100 megabytes by default. You can exceed this
62+
limit by setting the ``allowDiskUse`` property of ``AggregateOptions`` to ``true``. See
63+
the `AggregateOptions API documentation <{+api+}/interfaces/AggregateOptions.html>`__
6464
for more details.
6565

6666
.. important:: $graphLookup exception
@@ -69,8 +69,8 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
6969
</reference/operator/aggregation/graphLookup/>` stage has a strict
7070
memory limit of 100 megabytes and will ignore ``allowDiskUse``.
7171

72-
Useful References
73-
~~~~~~~~~~~~~~~~~
72+
References
73+
~~~~~~~~~~
7474

7575
To learn more about aggregation concepts, see the following pages in the
7676
Server manual:
@@ -117,7 +117,7 @@ In the example, the aggregation pipeline uses the following aggregation stages:
117117
:language: javascript
118118
:dedent:
119119

120-
This example should produce the following output:
120+
This example produces the following output:
121121

122122
.. code-block:: json
123123
:copyable: false

source/fundamentals/authentication/enterprise-mechanisms.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ The following code sample authenticates to Kerberos for UNIX using ``GSSAPI``.
9191

9292
.. note::
9393
The method refers to the ``GSSAPI`` authentication mechanism instead
94-
of ``Kerberos`` because the driver authenticates via
95-
`GSSAPI RFC-4652 <https://tools.ietf.org/html/rfc4752>`_ the SASL
94+
of ``Kerberos`` because the driver authenticates through
95+
`GSSAPI RFC-4652 <https://tools.ietf.org/html/rfc4752>`_, the SASL
9696
mechanism.
9797

9898
``LDAP (PLAIN)``

source/fundamentals/authentication/mechanisms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,5 +341,5 @@ connection URI.
341341
* - ``tlsAllowInvalidHostnames``
342342
- boolean
343343
- ``false``
344-
- Specifies whether the driver should permit a mismatch between the
344+
- Specifies whether the driver raises an error when there is a mismatch between the
345345
server hostname and TLS certificate hostname.

source/fundamentals/bson/undefined-values.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ You can specify the ``ignoreUndefined`` setting at the following levels:
7676
- The operation level
7777

7878
The ``ignoreUndefined`` setting automatically applies to the scope of the
79-
object instance in which you specified it, as well as any other objects created
79+
object instance in which you specified it and any other objects created
8080
from that instance.
8181

8282
For example, if you set the ``ignoreUndefined`` setting when

source/fundamentals/bson/utf8-validation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ between your application and MongoDB.
3232
.. note::
3333

3434
The current version of the {+driver-short+} automatically substitutes
35-
invalid UTF-8 characters with alternate valid UTF-8 ones prior to
35+
invalid UTF-8 characters with alternate valid UTF-8 ones before
3636
validation when you send data to MongoDB. Therefore, the validation
3737
only throws an error when the setting is enabled and the driver
3838
receives invalid UTF-8 document data from MongoDB.
@@ -45,7 +45,7 @@ Read the sections below to learn how to set UTF-8 validation using the
4545
Specify the UTF-8 Validation Setting
4646
------------------------------------
4747

48-
You can specify whether the driver should perform UTF-8 validation by
48+
You can specify whether the driver performs UTF-8 validation by
4949
defining the ``enableUtf8Validation`` setting in the options parameter
5050
when you create a client, reference a database or collection, or call a
5151
CRUD operation. If you omit the setting, the driver enables UTF-8 validation.

source/fundamentals/connection/connect.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ a MongoDB instance, or a replica set using the Node.js driver.
2626
Connection URI
2727
--------------
2828

29-
The **connection URI** is the set of instructions that the driver uses to
30-
connect to a MongoDB deployment. It instructs the driver on how it should
31-
connect to MongoDB and how it should behave while connected. The following
32-
example shows each part of the connection URI:
29+
The **connection URI** is the set of instructions that the driver uses to connect to a
30+
MongoDB deployment. It tells the driver how to connect to MongoDB and how to behave
31+
while connected. The following example shows each part of the connection URI:
3332

3433
.. figure:: /includes/figures/dns_seedlist_connection_string_parts.png
3534
:alt: Each part of the connection string

source/fundamentals/connection/connection-options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ parameters of the connection URI to specify the behavior of the client.
4545
* - **authMechanismProperties**
4646
- comma separated key:value pairs, for example, "opt1:val1,opt2:val2"
4747
- ``null``
48-
- Specifies additional options provided for authentication, such as
49-
enabling hostname canonicalization for GSSAPI.
48+
- Specifies other options provided for authentication, such as the option to enable
49+
hostname canonicalization for GSSAPI.
5050

5151
* - **authSource**
5252
- string

source/fundamentals/connection/network-compression.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ by specifying the algorithms in one of two ways:
5656
:tabid: mongoclientoptions
5757

5858
To enable compression using the `MongoClientOptions <{+api+}/api/global.html#MongoClientOptions>`__,
59-
pass the ``compressors`` option along with the compression
59+
pass the ``compressors`` option and the compression
6060
algorithm you want to use. You can specify one or more compression
6161
algorithms, separating them with commas:
6262

0 commit comments

Comments
 (0)