Skip to content

Commit 6c235c3

Browse files
authored
DOCSP-33951: atomic typos fy2024-q4 (#487)
* DOCSP-33951: atomic typos fy2024-q4 * vale fixes * vale fixes * NR PR fixes 1 * vale fixes * small fixes * small fixes
1 parent db9838b commit 6c235c3

File tree

15 files changed

+130
-103
lines changed

15 files changed

+130
-103
lines changed

source/connection-troubleshooting.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Monitor Thread Exception
250250

251251
INFO: Exception in monitor thread while connecting to server ssc-cluster-01-shard-00-02.9cbnp.mongodb.net:27017
252252

253-
To resolve this error, you need to manually install certificates as described
253+
To resolve this error, you must manually install certificates as described
254254
under :ref:`Error Sending Message <java-connection-certificate>`.
255255

256256
Certificate Request Exception

source/faq.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ How Does Connection Pooling Work in the Java Driver?
7575

7676
Every ``MongoClient`` instance has a built-in connection pool for each server
7777
in your MongoDB topology. Connection pools open sockets on demand to
78-
support concurrent MongoDB operations in your multithreaded application.
78+
support concurrent MongoDB operations in your multi-threaded application.
7979

8080
The maximum size of each connection pool is set by the ``maxPoolSize`` option, which
8181
defaults to ``100``. If the number of in-use connections to a server reaches
@@ -294,12 +294,12 @@ schema. You can use it for inheritance and storing multiple types of
294294
documents within the same collection or parent document (if you embed
295295
subdocuments).
296296

297-
For example, if you have an ``Event`` class that you extend in Java (e.g.
298-
``MachineEvent`` or ``NetworkEvent``), using a discriminator identifies
299-
which class the ``PojoCodecProvider`` should use to serialize/deserialize the
300-
document.
297+
For example, if you have an ``Event`` class that you extend in Java,
298+
such as ``MachineEvent`` or ``NetworkEvent``, using a discriminator
299+
identifies which class the ``PojoCodecProvider`` must use to
300+
serialize and deserialize the document.
301301

302-
For more information, see our :ref:`POJO Customization guide
302+
For more information, see the :ref:`POJO Customization guide
303303
<pojo-discriminators>`.
304304

305305
Can I control serialization of ``LocalDate``?

source/fundamentals/aggregation.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ Overview
1515

1616
In this guide, you can learn how to use **aggregation operations** in the MongoDB Java driver.
1717

18-
Aggregation operations process data in your MongoDB collections and return computed results. MongoDB's Aggregation
19-
pipeline, part of the Query API, is modeled on the concept of data processing pipelines. Documents enter a multi-staged pipeline that
18+
Aggregation operations process data in your MongoDB collections and
19+
return computed results. The MongoDB Aggregation framework, part of the
20+
Query API, is modeled on the concept of data processing pipelines.
21+
Documents enter a pipeline comprised of one or more stages that
2022
transforms the documents into an aggregated result.
2123

2224
Another way to think of aggregation is like a car factory. Within the car factory is an assembly line, along which

source/fundamentals/auth.txt

Lines changed: 62 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ confirm identity and establish trust to ensure security.
2525
The mechanisms that you can use with the latest version of MongoDB Community
2626
Edition are as follows:
2727

28-
* :ref:`Default <default-auth-mechanism>`
29-
* :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
30-
* :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
31-
* :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
32-
* :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
33-
* :ref:`X.509 <x509-auth-mechanism>`
28+
- :ref:`Default <default-auth-mechanism>`
29+
- :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
30+
- :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
31+
- :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
32+
- :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
33+
- :ref:`X.509 <x509-auth-mechanism>`
3434

3535
To authenticate using ``Kerberos`` or ``LDAP``, see the
3636
:doc:`Enterprise Authentication Mechanisms guide </fundamentals/enterprise-auth>`.
@@ -65,13 +65,18 @@ which they advertise support.
6565
The following code snippets show how to specify the authentication mechanism,
6666
using the following placeholders:
6767

68-
* ``username`` - your MongoDB username
69-
* ``password`` - your MongoDB user's password
70-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
71-
* ``port`` - port number of your MongoDB deployment
72-
* ``authenticationDb`` - MongoDB database that contains your user's
73-
authentication data. If you omit this parameter, the driver uses the
74-
default value ``admin``.
68+
- ``username``: your MongoDB username
69+
- ``password``: your MongoDB user's password
70+
- ``hostname``: network address of your MongoDB deployment that your
71+
client can access
72+
- ``port``: port number of your MongoDB deployment
73+
- ``authenticationDb``: MongoDB database that contains your user's
74+
authentication data
75+
76+
.. note::
77+
78+
If you omit the ``authenticationDb`` parameter, the driver uses the
79+
default ``admin`` database.
7580

7681
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
7782
tab below for instructions and sample code for specifying this authentication
@@ -123,13 +128,18 @@ algorithm, to authenticate your user.
123128
The following code snippets show how to specify the authentication mechanism,
124129
using the following placeholders:
125130

126-
* ``username`` - your MongoDB username.
127-
* ``password`` - your MongoDB user's password.
128-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
129-
* ``port`` - port number of your MongoDB deployment.
130-
* ``authenticationDb`` - MongoDB database that contains your user's
131-
authentication data. If you omit this parameter, the driver uses the
132-
default value ``admin``.
131+
- ``username``: your MongoDB username
132+
- ``password``: your MongoDB user's password
133+
- ``hostname``: network address of your MongoDB deployment that your
134+
client can access
135+
- ``port``: port number of your MongoDB deployment
136+
- ``authenticationDb``: MongoDB database that contains your user's
137+
authentication data
138+
139+
.. note::
140+
141+
If you omit the ``authenticationDb`` parameter, the driver uses the
142+
default ``admin`` database.
133143

134144
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
135145
tab below for instructions and sample code for specifying this authentication
@@ -175,13 +185,18 @@ your user.
175185
The following code snippets show how to specify the authentication mechanism,
176186
using the following placeholders:
177187

178-
* ``username`` - your MongoDB username.
179-
* ``password`` - your MongoDB user's password.
180-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
181-
* ``port`` - port number of your MongoDB deployment.
182-
* ``authenticationDb`` - MongoDB database that contains your user's
183-
authentication data. If you omit this parameter, the driver uses the
184-
default value ``admin``.
188+
- ``username``: your MongoDB username
189+
- ``password``: your MongoDB user's password
190+
- ``hostname``: network address of your MongoDB deployment that your
191+
client can access
192+
- ``port``: port number of your MongoDB deployment
193+
- ``authenticationDb``: MongoDB database that contains your user's
194+
authentication data
195+
196+
.. note::
197+
198+
If you omit the ``authenticationDb`` parameter, the driver uses the
199+
default ``admin`` database.
185200

186201
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
187202
tab below for instructions and sample code for specifying this authentication
@@ -254,12 +269,12 @@ provide your AWS IAM credentials in the next sections.
254269

255270
These sections contain code examples that use the following placeholders:
256271

257-
* ``awsKeyId`` - value of your AWS access key ID
258-
* ``awsSecretKey`` - value of your AWS secret access key
259-
* ``atlasUri`` - network address of your MongoDB Atlas deployment
260-
* ``hostname`` - hostname of your MongoDB Atlas deployment
261-
* ``port`` - port of your MongoDB Atlas deployment
262-
* ``awsSessionToken`` - value of your AWS session token
272+
- ``awsKeyId``: value of your AWS access key ID
273+
- ``awsSecretKey``: value of your AWS secret access key
274+
- ``atlasUri``: network address of your MongoDB Atlas deployment
275+
- ``hostname``: hostname of your MongoDB Atlas deployment
276+
- ``port``: port of your MongoDB Atlas deployment
277+
- ``awsSessionToken``: value of your AWS session token
263278

264279
.. _java-mongodb-aws-sdk:
265280

@@ -424,7 +439,6 @@ to the absolute path to this file, as shown in the following example:
424439

425440
export AWS_WEB_IDENTITY_TOKEN_FILE=<absolute path to file containing your OIDC token>
426441

427-
428442
To authenticate by using **ECS container credentials**, set the ECS
429443
endpoint relative URI in an environment variable by using ``bash`` or
430444
a similar shell as shown in the following example:
@@ -433,9 +447,10 @@ a similar shell as shown in the following example:
433447

434448
export AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=<your ECS endpoint>
435449

436-
To authenticate using **EC2 container credentials**, make sure none of the
437-
aforementioned environment variables are set. The driver obtains the
438-
credentials from the default IPv4 EC2 instance metadata endpoint.
450+
To authenticate by using **EC2 container credentials**, make sure none of the
451+
environment variables mentioned in this section are set. The driver obtains the
452+
credentials from the default IPv4 EC2 instance metadata endpoint instead
453+
of from environment variables.
439454

440455
.. _java-mongodb-aws-mongoclient-configuration:
441456

@@ -511,11 +526,16 @@ the subject name of the client certificate.
511526
The following code snippets show how to specify the authentication mechanism,
512527
using the following placeholders:
513528

514-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
515-
* ``port`` - port number of your MongoDB deployment.
516-
* ``authenticationDb`` - MongoDB database that contains your user's
517-
authentication data. If you omit this parameter, the driver uses the
518-
default value ``admin``.
529+
- ``hostname``: network address of your MongoDB deployment that your
530+
client can access
531+
- ``port``: port number of your MongoDB deployment
532+
- ``authenticationDb``: MongoDB database that contains your user's
533+
authentication data
534+
535+
.. note::
536+
537+
If you omit the ``authenticationDb`` parameter, the driver uses the
538+
default ``admin`` database.
519539

520540
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
521541
tab below for instructions and sample code for specifying this authentication

source/fundamentals/builders/aggregates.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -819,9 +819,8 @@ Densify
819819
-------
820820

821821
Use the ``densify()`` method to create a
822-
`$densify <https://www.mongodb.com/docs/rapid/reference/operator/aggregation/densify/>`__
823-
pipeline stage that generates a sequence of documents to span a specified
824-
interval.
822+
:manual:`$densify </reference/operator/aggregation/densify/>` pipeline
823+
stage that generates a sequence of documents to span a specified interval.
825824

826825
.. tip::
827826

source/fundamentals/builders/filters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ The evaluation operator methods include:
342342
- Matches
343343

344344
* - `mod() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#mod(java.lang.String,long,long)>`__
345-
- documents where a modulo operation on the value of a field contain a specified result.
345+
- documents where a modulo operation on a field value produces a specified result.
346346

347347
* - `regex() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#regex(java.lang.String,java.lang.String)>`__
348348
- documents where values contain a specified regular expression.

source/fundamentals/connection/tls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ the following mechanisms:
9696
.. note::
9797

9898
The following sections are based on the documentation for Oracle JDK,
99-
so some parts may be inapplicable to your JDK or to the custom TLS/SSL
100-
implementation you use.
99+
so some might not apply to your JDK or to your custom TLS/SSL
100+
implementation.
101101

102102
.. _tls-configure-jvm-truststore:
103103

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ iterate through results in a functional style:
173173

174174
.. code-block:: java
175175

176-
for (Document cur : collection.find()) {
176+
for (Document cursor : collection.find()) {
177177
...
178178
}
179179

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Bulk Operations
55
===============
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none

source/fundamentals/data-formats/pojo-customization.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ metadata.
142142
PropertyModel
143143
~~~~~~~~~~~~~
144144

145-
A ``PropertyModel`` stores information on how to serialize/deserialize a
145+
A ``PropertyModel`` stores information on how to serialize and deserialize a
146146
specific field in a document.
147147

148148
The ``PropertyModel`` contains the following information:
@@ -563,8 +563,7 @@ following:
563563
:ref:`Conventions <conventions>`.
564564
- Create a custom class that overrides the ``shouldSerialize()`` method of the
565565
``PropertySerialization`` interface. Specify your custom implementation to
566-
the ``PropertyModelBuilder`` which is accessible from the
567-
``ClassModelBuilder``.
566+
the ``PropertyModelBuilder`` which you can access from the ``ClassModelBuilder``.
568567

569568
For more information on how to use the ``@BsonIgnore`` annotation in a POJO,
570569
see the section of this guide on :ref:`Annotations <annotations>`.

source/fundamentals/enterprise-auth.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Enterprise Authentication Mechanisms
55
====================================
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none
@@ -58,9 +56,10 @@ principal name.
5856
The following code snippets show how to specify the authentication mechanism,
5957
using the following placeholders:
6058

61-
* ``username`` - your URL-encoded principal name, e.g. "username%40REALM.ME"
62-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
63-
* ``port`` - port number of your MongoDB deployment
59+
- ``username``: your URL-encoded principal name, such as ``"username%40REALM.ME"``
60+
- ``hostname``: network address of your MongoDB deployment that your
61+
client can access
62+
- ``port``: port number of your MongoDB deployment
6463

6564
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
6665
tab below for instructions and sample code for specifying this authentication
@@ -240,10 +239,11 @@ parameter to ``PLAIN`` and including your LDAP username and password in the
240239
The following code snippets show how to specify the authentication mechanism,
241240
using the following placeholders:
242241

243-
* ``username`` - your LDAP username
244-
* ``password`` - your LDAP user's password
245-
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
246-
* ``port`` - port number of your MongoDB deployment
242+
- ``username``: your LDAP username
243+
- ``password``: your LDAP user's password
244+
- ``hostname``: network address of your MongoDB deployment that your
245+
client can access
246+
- ``port``: port number of your MongoDB deployment
247247

248248
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
249249
tab below for instructions and sample code for specifying this authentication

source/fundamentals/logging.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -224,9 +224,9 @@ project.
224224
.. tab:: Logback
225225
:tabid: Logback-binding
226226

227-
Specify Logback configurations in a file named ``logback.xml``. Your
228-
``logback.xml`` file does not have to be in a specific location, but it must
229-
be accessible from your classpath.
227+
Specify Logback configurations in a file named ``logback.xml``.
228+
You don't need to create your ``logback.xml`` file in a specific
229+
location, but you must be able to access it from your classpath.
230230

231231
The Logback framework defines the following log levels. The
232232
following lists the log levels, ordered from most urgent to least
@@ -278,9 +278,9 @@ project.
278278
.. tab:: Log4j2
279279
:tabid: Log4j2-binding
280280

281-
Specify Log4j2 configurations in a file named ``log4j2.xml``. Your
282-
``log4j2.xml`` file does not have to be in a specific location, but it must
283-
be accessible from your classpath.
281+
Specify Log4j2 configurations in a file named ``log4j2.xml``.
282+
You don't need to create your ``log4j2.xml`` file in a specific
283+
location, but you must be able to access it from your classpath.
284284

285285
The Log4j2 framework defines the following log levels. The following lists the
286286
log levels, ordered from most urgent to least urgent:

source/issues-and-help.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ driver, please open a case in our issue management tool, JIRA:
3030
* Click :guilabel:`Create`. Please provide as much information as possible
3131
about the issue and the steps to reproduce it.
3232

33-
Bug reports in JIRA for the Java driver and the Core Server (i.e. SERVER) project are **public**.
33+
Bug reports in JIRA for the Java driver and the Core Server (SERVER) project are **public**.
3434

3535
If you’ve identified a security vulnerability in a driver or any other
3636
MongoDB project, please report it according to the instructions found in the

0 commit comments

Comments
 (0)