Skip to content

Commit 365fd2f

Browse files
Docsp 16491 typos (#106)
Co-authored-by: kyuan-mongodb <[email protected]>
1 parent 5a61843 commit 365fd2f

20 files changed

+75
-76
lines changed
97.3 KB
Loading

source/includes/quick-start/atlas-setup.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Set up a Free Tier Cluster in Atlas
44
After setting up your Java project dependencies, create a MongoDB cluster
55
where you can store and manage your data. Complete the
66
:atlas:`Get Started with Atlas </getting-started>` guide to set up a new
7-
Atlas account, free tier MongoDB cluster, load datasets, and
7+
Atlas account, create and launch a free tier MongoDB cluster, load datasets, and
88
interact with the data.
99

1010
After completing the steps in the Atlas guide, you should have a new MongoDB
@@ -14,11 +14,11 @@ into your cluster.
1414
Connect to your Cluster
1515
-----------------------
1616

17-
In this step, we create and run an application that uses the Java MongoDB
17+
In this step, we create and run an application that uses the MongoDB Java
1818
driver to connect to your MongoDB cluster and run a query on the sample
1919
data.
2020

21-
We pass instructions to the driver on where and how to connect to your
21+
We pass instructions to the driver on how to connect to your
2222
MongoDB cluster in a string called the *connection string*. This string
2323
includes information on the hostname or IP address and port of your
2424
cluster, authentication mechanism, user credentials when applicable, and
@@ -33,8 +33,9 @@ want to connect to as shown below.
3333
:alt: Atlas Connection GUI cluster selection screen
3434

3535
Proceed to the **Connect Your Application** step and select the Java driver.
36-
Then, select the "Connection String Only" tab and click the **Copy**
37-
button to copy the *connection string* to your clipboard as shown below.
36+
Select "4.1 or Later" for the version.
37+
Click the **Copy** icon to copy the *connection string* to your clipboard as
38+
shown below.
3839

3940
.. figure:: /includes/figures/atlas_connection_copy_string.png
4041
:alt: Atlas Connection GUI connection string screen

source/includes/quick-start/pojo-query-output.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
When you run the ``QuickStartPojoExample`` class, it should output the details of the
2-
movie from the sample dataset which will look something like this:
2+
movie from the sample dataset which should look something like this:
33

44
.. code-block:: none
55

source/includes/usage-examples/code-snippets/ReplaceOne.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// ignored first line
21
package usage.examples;
32

43
import static com.mongodb.client.model.Filters.eq;

source/includes/usage-examples/code-snippets/UpdateMany.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// ignored first line
21
package usage.examples;
32

43
import static com.mongodb.client.model.Filters.gt;

source/usage-examples.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ Overview
2727
--------
2828

2929
Usage examples provide convenient starting points for popular MongoDB
30-
operations. Each example provides:
30+
operations. Each example provides the following information:
3131

32-
- an explanation of the operation in the example showing the
32+
- An explanation of the operation in the example showing the
3333
purpose and a sample use case for the method
3434

35-
- an explanation of how to use the operation, including parameters,
35+
- An explanation of how to use the operation, including parameters,
3636
return values, and common exceptions you might encounter
3737

38-
- a full Java class that you can copy and paste to run the example
38+
- A full Java class that you can copy and paste to run the example
3939
in your own environment
4040

4141
How to Use the Usage Examples
@@ -54,20 +54,20 @@ example into your development environment of choice. You can follow the
5454
:doc:`quick start guide </quick-start>` to learn more about getting
5555
started with the MongoDB Java driver. Once you've copied a usage example,
5656
you'll need to edit the connection string to get the example connected to
57-
your instance of MongoDB:
57+
your MongoDB instance:
5858

5959
.. code-block:: java
6060

6161
// Replace the following with your MongoDB deployment's connection string.
6262
String uri = "mongodb+srv://<user>:<password>@<cluster-url>?retryWrites=true&w=majority";
6363

6464
You can use the :guides:`Atlas Connectivity Guide </cloud/connectionstring/>`
65-
to enable connectivity to your instance of Atlas and find the
66-
:manual:`connection string </reference/connection-string/>` to replace the
67-
``uri`` variable in the usage example. If your instance uses
65+
to learn how to allow connections to your instance of Atlas and to find the
66+
:manual:`connection string </reference/connection-string/>` you use to replace the
67+
``uri`` variable in usage examples. If your instance uses
6868
:manual:`SCRAM authentication </core/security-scram/>`, you can replace
6969
``<user>`` with your username, ``<password>`` with your password, and
7070
``<cluster-url>`` with the IP address or URL of your instance.
7171

72-
For more information about connecting to your MongoDB instance, see the
73-
Connection Guide.
72+
For more information about connecting to your MongoDB instance, see our
73+
:doc:`Connection Guide </fundamentals/connection/>`.

source/usage-examples/bulkWrite.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Perform Bulk Operations
77

88
The ``bulkWrite()`` method performs batch write operations against a
99
*single* collection. This method reduces the number of network round trips from
10-
your application to the server which therefore increases the potential
11-
throughput and performance. Since you only receive the success status after
10+
your application to your MongoDB instance which increases the performance of your
11+
application. Since you only receive the success status after
1212
all the operations return, we recommend you use this if that meets the
1313
requirements of your use case.
1414

@@ -25,13 +25,13 @@ You can specify one or more of the following write operations in
2525
The ``bulkWrite()`` method accepts the following parameters:
2626

2727
- A ``List`` of objects that implement ``WriteModel``: the classes that
28-
implement the ``WriteModel`` correspond to the aforementioned write
28+
implement ``WriteModel`` correspond to the aforementioned write
2929
operations. E.g. the ``InsertOneModel`` class wraps the ``insertOne`` write
3030
operation. See the links to the API documentation at the bottom of this page
3131
for more information on each class.
3232

3333
- ``BulkWriteOptions``: *optional* object that specifies settings such as
34-
whether to ensure the writes are ordered.
34+
whether to ensure your MongoDB instance orders your write operations.
3535

3636
.. note::
3737

@@ -46,9 +46,9 @@ The ``bulkWrite()`` method accepts the following parameters:
4646
an error occurs during the processing of an operation, MongoDB returns
4747
without processing the remaining operations in the list. In contrast,
4848
when you set ``ordered`` to ``false``, MongoDB continues to process remaining
49-
write operations in the list. Unordered operations are theoretically faster
50-
since MongoDB can execute them in parallel, but should only be used if
51-
the writes do not depend on order.
49+
write operations in the list in the event of an error. Unordered operations
50+
are theoretically faster since MongoDB can execute them in parallel, but
51+
you should only use them if your writes do not depend on order.
5252

5353
The ``bulkWrite()`` method returns a ``BulkWriteResult`` object that
5454
contains information about the write operation results including the number

source/usage-examples/command.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can run all raw database operations using the
99
command you can execute directly on the MongoDB server CLI. These
1010
commands include administrative and diagnostic tasks, such as fetching
1111
server stats or initializing a replica set. Call the ``runCommand()``
12-
method with a Bson command object on an instance of a ``MongoDatabase``
12+
method with a ``Bson`` command object on an instance of a ``MongoDatabase``
1313
to run your raw database operation.
1414

1515
.. note::
@@ -18,7 +18,7 @@ to run your raw database operation.
1818
since these tasks are often quicker and easier to implement with the
1919
shell than in a Java application.
2020

21-
The ``runCommand()`` method accepts a command in Bson format.
21+
The ``runCommand()`` method accepts a command in the form of a ``Bson`` object.
2222
By default, ``runCommand`` returns an object of type
2323
``org.bson.Document`` containing the output of the database command. You
2424
can specify a return type for ``runCommand()`` as an optional second

source/usage-examples/count.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ call to count the number of documents in a collection:
1515
documents in the collection based on the collection metadata. You cannot
1616
specify a query when using this method.
1717

18-
The ``estimatedDocumentCount()`` method returns more quickly than
18+
The ``estimatedDocumentCount()`` method returns more quickly than the
1919
``countDocuments()`` method because it uses the collection's metadata rather
2020
than scanning the entire collection. The ``countDocuments()`` method returns
2121
an **accurate** count of the number of documents and supports specifying
@@ -34,7 +34,7 @@ specify the behavior of the call:
3434
:widths: 17 20 10
3535

3636
* - Method
37-
- Optional Paramter Class
37+
- Optional Parameter Class
3838
- Description
3939

4040
* - ``countDocuments()``

source/usage-examples/deleteMany.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ MongoDB matches all documents in the collection and deletes them. While
1313
you can use ``deleteMany()`` to delete all documents in a collection,
1414
consider using the ``drop()`` method instead for better performance.
1515

16-
Upon successful delete, this method returns an instance of
16+
Upon successful deletion, this method returns an instance of
1717
``DeleteResult``. You can retrieve information such as the number of
1818
documents deleted by calling the ``getDeletedCount()`` method on the
19-
``DeleteResult``.
19+
``DeleteResult`` instance.
2020

2121
If your delete operation fails, the driver raises an exception. For more
2222
information on the types of exceptions raised under specific conditions,

0 commit comments

Comments
 (0)