Skip to content

DOCSP-33951: atomic typos fy2024-q4 #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/connection-troubleshooting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Monitor Thread Exception

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

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

Certificate Request Exception
Expand Down
12 changes: 6 additions & 6 deletions source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ How Does Connection Pooling Work in the Java Driver?

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

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

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

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

Can I control serialization of ``LocalDate``?
Expand Down
6 changes: 4 additions & 2 deletions source/fundamentals/aggregation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ Overview

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

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

Another way to think of aggregation is like a car factory. Within the car factory is an assembly line, along which
Expand Down
104 changes: 62 additions & 42 deletions source/fundamentals/auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ confirm identity and establish trust to ensure security.
The mechanisms that you can use with the latest version of MongoDB Community
Edition are as follows:

* :ref:`Default <default-auth-mechanism>`
* :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
* :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
* :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
* :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
* :ref:`X.509 <x509-auth-mechanism>`
- :ref:`Default <default-auth-mechanism>`
- :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
- :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
- :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
- :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
- :ref:`X.509 <x509-auth-mechanism>`

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

* ``username`` - your MongoDB username
* ``password`` - your MongoDB user's password
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
* ``port`` - port number of your MongoDB deployment
* ``authenticationDb`` - MongoDB database that contains your user's
authentication data. If you omit this parameter, the driver uses the
default value ``admin``.
- ``username``: your MongoDB username
- ``password``: your MongoDB user's password
- ``hostname``: network address of your MongoDB deployment that your
client can access
- ``port``: port number of your MongoDB deployment
- ``authenticationDb``: MongoDB database that contains your user's
authentication data

.. note::

If you omit the ``authenticationDb`` parameter, the driver uses the
default ``admin`` database.

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

* ``username`` - your MongoDB username.
* ``password`` - your MongoDB user's password.
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
* ``port`` - port number of your MongoDB deployment.
* ``authenticationDb`` - MongoDB database that contains your user's
authentication data. If you omit this parameter, the driver uses the
default value ``admin``.
- ``username``: your MongoDB username
- ``password``: your MongoDB user's password
- ``hostname``: network address of your MongoDB deployment that your
client can access
- ``port``: port number of your MongoDB deployment
- ``authenticationDb``: MongoDB database that contains your user's
authentication data

.. note::

If you omit the ``authenticationDb`` parameter, the driver uses the
default ``admin`` database.

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

* ``username`` - your MongoDB username.
* ``password`` - your MongoDB user's password.
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
* ``port`` - port number of your MongoDB deployment.
* ``authenticationDb`` - MongoDB database that contains your user's
authentication data. If you omit this parameter, the driver uses the
default value ``admin``.
- ``username``: your MongoDB username
- ``password``: your MongoDB user's password
- ``hostname``: network address of your MongoDB deployment that your
client can access
- ``port``: port number of your MongoDB deployment
- ``authenticationDb``: MongoDB database that contains your user's
authentication data

.. note::

If you omit the ``authenticationDb`` parameter, the driver uses the
default ``admin`` database.

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

These sections contain code examples that use the following placeholders:

* ``awsKeyId`` - value of your AWS access key ID
* ``awsSecretKey`` - value of your AWS secret access key
* ``atlasUri`` - network address of your MongoDB Atlas deployment
* ``hostname`` - hostname of your MongoDB Atlas deployment
* ``port`` - port of your MongoDB Atlas deployment
* ``awsSessionToken`` - value of your AWS session token
- ``awsKeyId``: value of your AWS access key ID
- ``awsSecretKey``: value of your AWS secret access key
- ``atlasUri``: network address of your MongoDB Atlas deployment
- ``hostname``: hostname of your MongoDB Atlas deployment
- ``port``: port of your MongoDB Atlas deployment
- ``awsSessionToken``: value of your AWS session token

.. _java-mongodb-aws-sdk:

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

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


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

export AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=<your ECS endpoint>

To authenticate using **EC2 container credentials**, make sure none of the
aforementioned environment variables are set. The driver obtains the
credentials from the default IPv4 EC2 instance metadata endpoint.
To authenticate by using **EC2 container credentials**, make sure none of the
environment variables mentioned in this section are set. The driver obtains the
credentials from the default IPv4 EC2 instance metadata endpoint instead
of from environment variables.

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

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

* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
* ``port`` - port number of your MongoDB deployment.
* ``authenticationDb`` - MongoDB database that contains your user's
authentication data. If you omit this parameter, the driver uses the
default value ``admin``.
- ``hostname``: network address of your MongoDB deployment that your
client can access
- ``port``: port number of your MongoDB deployment
- ``authenticationDb``: MongoDB database that contains your user's
authentication data

.. note::

If you omit the ``authenticationDb`` parameter, the driver uses the
default ``admin`` database.

Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
tab below for instructions and sample code for specifying this authentication
Expand Down
5 changes: 2 additions & 3 deletions source/fundamentals/builders/aggregates.txt
Original file line number Diff line number Diff line change
Expand Up @@ -819,9 +819,8 @@ Densify
-------

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

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/builders/filters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ The evaluation operator methods include:
- Matches

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

* - `regex() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#regex(java.lang.String,java.lang.String)>`__
- documents where values contain a specified regular expression.
Expand Down
4 changes: 2 additions & 2 deletions source/fundamentals/connection/tls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ the following mechanisms:
.. note::

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

.. _tls-configure-jvm-truststore:

Expand Down
2 changes: 1 addition & 1 deletion source/fundamentals/crud/read-operations/cursor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ iterate through results in a functional style:

.. code-block:: java

for (Document cur : collection.find()) {
for (Document cursor : collection.find()) {
...
}

Expand Down
2 changes: 0 additions & 2 deletions source/fundamentals/crud/write-operations/bulk.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
Bulk Operations
===============

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
Expand Down
5 changes: 2 additions & 3 deletions source/fundamentals/data-formats/pojo-customization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ metadata.
PropertyModel
~~~~~~~~~~~~~

A ``PropertyModel`` stores information on how to serialize/deserialize a
A ``PropertyModel`` stores information on how to serialize and deserialize a
specific field in a document.

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

For more information on how to use the ``@BsonIgnore`` annotation in a POJO,
see the section of this guide on :ref:`Annotations <annotations>`.
Expand Down
18 changes: 9 additions & 9 deletions source/fundamentals/enterprise-auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
Enterprise Authentication Mechanisms
====================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
Expand Down Expand Up @@ -58,9 +56,10 @@ principal name.
The following code snippets show how to specify the authentication mechanism,
using the following placeholders:

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

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

* ``username`` - your LDAP username
* ``password`` - your LDAP user's password
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
* ``port`` - port number of your MongoDB deployment
- ``username``: your LDAP username
- ``password``: your LDAP user's password
- ``hostname``: network address of your MongoDB deployment that your
client can access
- ``port``: port number of your MongoDB deployment

Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
tab below for instructions and sample code for specifying this authentication
Expand Down
12 changes: 6 additions & 6 deletions source/fundamentals/logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,9 @@ project.
.. tab:: Logback
:tabid: Logback-binding

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

The Logback framework defines the following log levels. The
following lists the log levels, ordered from most urgent to least
Expand Down Expand Up @@ -278,9 +278,9 @@ project.
.. tab:: Log4j2
:tabid: Log4j2-binding

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

The Log4j2 framework defines the following log levels. The following lists the
log levels, ordered from most urgent to least urgent:
Expand Down
2 changes: 1 addition & 1 deletion source/issues-and-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ driver, please open a case in our issue management tool, JIRA:
* Click :guilabel:`Create`. Please provide as much information as possible
about the issue and the steps to reproduce it.

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

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