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 3 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/deserialize the document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S:

Suggested change
serialize/deserialize the document.
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
8 changes: 4 additions & 4 deletions source/fundamentals/auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,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 +432,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
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: 1 addition & 1 deletion source/fundamentals/enterprise-auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ 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"
* ``username`` - your URL-encoded principal name, for example "username%40REALM.ME"
Copy link
Contributor

@norareidy norareidy Nov 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S:

Suggested change
* ``username`` - your URL-encoded principal name, for example "username%40REALM.ME"
* ``username`` - your URL-encoded principal name, such as "username%40REALM.ME"

* ``hostname`` - network address of your MongoDB deployment, accessible by your client
* ``port`` - port number of your MongoDB deployment

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
27 changes: 15 additions & 12 deletions source/usage-examples/bulkWrite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ You can specify one or more of the following write operations in
The ``bulkWrite()`` method accepts the following parameters:

- A ``List`` of objects that implement ``WriteModel``: the classes that
implement ``WriteModel`` correspond to the aforementioned write
operations. E.g. the ``InsertOneModel`` class wraps the ``insertOne`` write
operation. See the links to the API documentation at the bottom of this page
for more information on each class.
implement ``WriteModel`` correspond to the preceding write
operation methods. For example, the ``InsertOneModel`` class wraps the
``insertOne`` write operation. See the links to the API documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S:

Suggested change
``insertOne`` write operation. See the links to the API documentation
``insertOne()`` write operation. See the links to the API documentation

at the end of this page for more information about each class.

- ``BulkWriteOptions``: *optional* object that specifies settings such as
whether to ensure your MongoDB instance orders your write operations.
Expand All @@ -43,14 +43,17 @@ The ``bulkWrite()`` method accepts the following parameters:

.. tip::

By default, MongoDB executes bulk write operations one-by-one in the
specified order (i.e. serially). During an ordered bulk write, if
an error occurs during the processing of an operation, MongoDB returns
without processing the remaining operations in the list. In contrast,
when you set ``ordered`` to ``false``, MongoDB continues to process remaining
write operations in the list in the event of an error. Unordered operations
are theoretically faster since MongoDB can execute them in parallel, but
you should only use them if your writes do not depend on order.
By default, MongoDB executes operations in a bulk write in the
specified order. During an ordered bulk write, if
an error occurs during the processing of an operation, MongoDB returns
without processing the remaining operations in the list.

In contrast, when you set the ``ordered`` option to ``false``, MongoDB
continues to process the remaining write operations in the list even in the
event of an error. Unordered operations are usually faster since
MongoDB can execute them in parallel, but only use an
unordered bulk write if the order of your write operations is not
important.

The ``bulkWrite()`` method returns a ``BulkWriteResult`` object that
contains information about the write operation results including the number
Expand Down
17 changes: 11 additions & 6 deletions source/usage-examples/command.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,17 @@ server stats or initializing a replica set. Call the ``runCommand()``
method with a ``Bson`` command object on an instance of a ``MongoDatabase``
to run your raw database operation.

.. tip::

Use the :mongosh:`MongoDB Shell </>` for
administrative tasks instead of the Java driver whenever possible,
since these tasks are often quicker and easier to implement with the
shell than in a Java application.
.. important:: Prefer Driver Methods to Database Commands

The driver provides wrapper methods for many database commands.
We recommend using driver methods instead of executing database
commands when possible.

To perform administrative tasks, use the :mongosh:`MongoDB Shell </>`
instead of the {+driver-short+}. Calling the ``db.runCommand()``
method inside the shell is the preferred way to issue database
commands, as it provides a consistent interface between the shell and
drivers.

The ``runCommand()`` method accepts a command in the form of a ``Bson`` object.
By default, ``runCommand`` returns an object of type
Expand Down