Skip to content

Commit a44194a

Browse files
committed
DOCSP-33478: fix vale issues (#108)
(cherry picked from commit 118e6f6)
1 parent 6b5a032 commit a44194a

16 files changed

+43
-53
lines changed

source/fundamentals/aggregation.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,7 @@ The aggregation pipeline contains the following stages:
148148
``genre_interests`` field into a new document.
149149
- A ``$group`` stage to group documents by the value of the
150150
``genre_interests`` field. This stage finds the average, minimum, and
151-
maximum user age for users, using the ``$avg``, ``$min``, and ``$max``
152-
operators, respectively.
151+
maximum user age by using the ``$avg``, ``$min``, and ``$max`` operators.
153152

154153
.. io-code-block::
155154

source/fundamentals/connections/connection-options.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ connected to the server.
4040
* - **authMechanismProperties**
4141
- String
4242
- None
43-
- Specifies additional properties for the authentication mechanism
43+
- Specifies more properties for the authentication mechanism
4444
set in the ``authMechanism`` option.
4545

4646
* - **authSource**
@@ -72,7 +72,7 @@ connected to the server.
7272
* - **heartbeatFrequencyMS**
7373
- Integer greater than or equal to 500
7474
- ``10000`` (10 seconds)
75-
- Specifies the amount of time, in milliseconds, that each
75+
- Specifies the amount of time in milliseconds that each
7676
monitoring thread waits between performing server checks.
7777

7878
* - **journal**
@@ -83,8 +83,8 @@ connected to the server.
8383
* - **localThresholdMS**
8484
- Non-negative integer
8585
- 15
86-
- | Specifies how much longer, in milliseconds, that the average
87-
round-trip time between the driver and server can take
86+
- | Specifies the amount of time in milliseconds that the average
87+
round-trip time between the driver and server can last
8888
compared to the shortest round-trip time of all the suitable servers.
8989
| A value of ``0`` indicates that there is no latency window, so
9090
only the server with the lowest average round-trip time is
@@ -93,7 +93,7 @@ connected to the server.
9393
* - **maxIdleTimeMS**
9494
- Non-negative integer
9595
- 0
96-
- | Specifies the amount of time, in milliseconds, that a connection
96+
- | Specifies the amount of time in milliseconds that a connection
9797
can remain idle in a connection pool the server closes it.
9898
| A value of ``0`` indicates that the client does not close idle
9999
connections.
@@ -157,7 +157,7 @@ connected to the server.
157157
* - **serverSelectionTimeoutMS**
158158
- Non-negative integer
159159
- ``30000`` (30 seconds)
160-
- Specifies the amount of time, in milliseconds, that the
160+
- Specifies the amount of time in milliseconds that the
161161
``Client`` instance waits when attempting to select a server for an
162162
operation before timing out.
163163

source/fundamentals/crud/compound-operations.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The following table describes the options available in
112112
- Description
113113

114114
* - ``max_time``
115-
- | The maximum amount of time, in milliseconds, that the query can
115+
- | The maximum amount of time in milliseconds that the query can
116116
run.
117117
|
118118
| Type: ``Duration``
@@ -265,7 +265,7 @@ The following table describes the options available in
265265
| Default: ``false``
266266

267267
* - ``max_time``
268-
- | The maximum amount of time, in milliseconds, that the query can
268+
- | The maximum amount of time in milliseconds that the query can
269269
run.
270270
|
271271
| Type: ``Duration``
@@ -396,7 +396,7 @@ Find and Replace a Document
396396

397397
The ``find_one_and_replace()`` method finds and replaces the first
398398
document that matches the specified query filter. The operation replaces
399-
all of the fields of the document except the ``_id`` field with fields
399+
all the fields of the document except the ``_id`` field with fields
400400
and values that you provide. If a document matches the filter criteria,
401401
the method returns a ``Some`` type. If no documents match, it returns a
402402
``None`` type.
@@ -434,7 +434,7 @@ The following table describes the options available in
434434
| Default: ``false``
435435

436436
* - ``max_time``
437-
- | The maximum amount of time, in milliseconds, that the query can
437+
- | The maximum amount of time in milliseconds that the query can
438438
run.
439439
|
440440
| Type: ``Duration``

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Sample Data
9393

9494
The examples in this guide use the following sample documents. Each
9595
document represents a fruit in a store's inventory and contains
96-
information about its quantity. Some documents contain additional fields
96+
information about its quantity. Some documents contain fields
9797
that describe the fruit or its vendors.
9898

9999
.. literalinclude:: /includes/fundamentals/code-snippets/crud/query.rs
@@ -226,7 +226,7 @@ divisible by ``3``:
226226
.. note::
227227

228228
If a query filter contains a literal value query with multiple field-value pairs,
229-
the driver matches documents that meet all of the criteria.
229+
the driver matches documents that meet all the criteria.
230230

231231
For example, the following queries produce equivalent results:
232232

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,10 @@ Find Operations
6767
Use find operations to retrieve data from MongoDB. Find operations
6868
consist of the ``find()`` and ``find_one()`` methods.
6969

70-
You can also run find operations after starting a session with the
71-
``find_with_session()`` and ``find_one_with_session()`` methods. Both methods
72-
take an additional ``ClientSession`` parameter, or a logical session used for
73-
ordering sequential operations. To learn more about these two methods, see the
74-
API documentation for `find_with_session() <{+api+}/struct.Collection.html#method.find_with_session>`__
75-
and `find_one_with_session() <{+api+}/struct.Collection.html#method.find_one_with_session>`__.
76-
7770
Find All Matching Documents
7871
~~~~~~~~~~~~~~~~~~~~~~~~~~~
7972

80-
To find *all of the documents* that match your criteria, use the
73+
To find *all the documents* that match your criteria, use the
8174
``find()`` method. This method takes a query filter as a parameter. A
8275
query filter consists of the fields and values that form criteria for
8376
documents to match.
@@ -281,7 +274,7 @@ To learn more about aggregations and view aggregation examples, see the :ref:`ru
281274
The method returns the resulting documents in a ``Cursor`` type. If
282275
your aggregation pipeline does not contain a :manual:`$match
283276
</reference/operator/aggregation/match/>` stage, the pipeline processes
284-
all of the documents in the collection.
277+
all the documents in the collection.
285278

286279
Modify Aggregation Behavior
287280
~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ following parameters:
177177

178178
.. note::
179179

180-
If the preceding example used the ``delete_one()`` method instead of
181-
``delete_many()`` for the delete operation, the driver would delete
182-
the first of the two documents that matched the query filter.
180+
If you use the ``delete_one()`` method instead of
181+
``delete_many()`` in the preceding code example, the driver deletes
182+
only the first of the two documents that match the query filter.
183183

184184
.. _rust-crud-del-addtl-info:
185185

source/fundamentals/database-collection.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ the ``list_database_names()`` method:
100100
Drop a Database
101101
---------------
102102

103-
Dropping a database permanently deletes all of the data in that database's
103+
Dropping a database permanently deletes all the data in that database's
104104
collections. To drop a database, call the `drop()
105105
<{+api+}/struct.Database.html#method.drop>`__ method
106106
on your ``Database`` instance. The following code shows
@@ -256,7 +256,7 @@ a database referenced by the ``db`` variable by using the
256256
Drop a Collection
257257
-----------------
258258

259-
Dropping a collection permanently deletes all of the data in that
259+
Dropping a collection permanently deletes all the data in that
260260
collection. To drop a collection, call the `drop()
261261
<{+api+}/struct.Collection.html#method.drop>`__ method
262262
on your ``Collection`` instance. The following code shows

source/fundamentals/enterprise-auth.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ authentication mechanism by using the following placeholders:
9292

9393
Because your credentials are stored outside of MongoDB, you must use the
9494
``$external`` database for authentication. The ``source`` field of
95-
the ``Credential`` struct defaults to ``$external``, so you do
96-
not need to explicitly set this field.
95+
the ``Credential`` struct defaults to ``$external``, so you can omit
96+
this field.
9797

9898
Alternatively, you can authenticate by using a connection string URI by
9999
setting the value of the ``authMechanism`` connection string option to ``PLAIN``.

source/fundamentals/stable-api.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ are compatible with that version.
5757

5858
.. note::
5959

60-
The {+driver-long+} currently supports only {+stable-api+} version 1.
60+
The {+driver-long+} supports only {+stable-api+} version 1.
6161

6262
API Version Specification Example
6363
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/fundamentals/tracing-logging.txt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,17 @@ In this guide, you can learn how to use the {+driver-short+} to configure
1717
**tracing** and **logging** for your application. Tracing and logging
1818
are two frameworks for observing your application. Logging allows you to
1919
view a discrete, event-based log of driver activities, while tracing
20-
provides a continuous view. Logs might help you identify an issue in
21-
your application, while a trace might help you locate the reason for the
22-
issue.
20+
provides a continuous view.
2321

2422
In the {+driver-short+}, the functionalities of tracing and logging do not
2523
differ greatly. However, when you enable tracing, the driver emits messages in a
26-
more structured format, which can make it easier for your application to
24+
more structured format, which can make it more convenient for your application to
2725
consume event messages programmatically.
2826

2927
Tracers and loggers log messages at a severity, or verbosity, level that you
3028
can specify. By enabling one of these components in your application,
31-
you can receive information about your application's activities at a
32-
high level, a detailed level, or somewhere in between.
29+
you can receive information about your application's activities at
30+
different levels of detail.
3331

3432
.. tip::
3533

@@ -90,8 +88,8 @@ against and their corresponding targets:
9088
To specify the logging component and severity level, you can set the
9189
``RUST_LOG`` environment variable when you compile and run your
9290
application. Specify the logging component by setting the value of
93-
``RUST_LOG`` to one of the targets provided in the preceding table,
94-
along with a severity level.
91+
``RUST_LOG`` to one of the targets provided in the preceding table and
92+
including a severity level.
9593

9694
The following code shows a command to execute a program that records
9795
connection events at the ``debug`` level:

0 commit comments

Comments
 (0)