Skip to content

Commit 55cfdbb

Browse files
Docsp 16491 typos after builders (#114)
1 parent 4e4d744 commit 55cfdbb

File tree

10 files changed

+46
-49
lines changed

10 files changed

+46
-49
lines changed

source/compatibility.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ Compatibility
44
MongoDB Compatibility
55
~~~~~~~~~~~~~~~~~~~~~
66

7-
The following compatibility table specifies the recommended version(s) of the
7+
The following compatibility table specifies the recommended versions of the
88
MongoDB Java driver for use with a specific version of MongoDB.
99

10-
The first column lists the driver version(s).
10+
The first column lists the driver versions.
1111

1212
.. include:: /includes/mongodb-compatibility-table-java.rst
1313

1414
Language Compatibility
1515
~~~~~~~~~~~~~~~~~~~~~~
1616

17-
The following compatibility table specifies the recommended version(s) of the
17+
The following compatibility table specifies the recommended versions of the
1818
MongoDB Java driver for use with a specific version of Java.
1919

20-
The first column lists the driver version(s).
20+
The first column lists the driver versions.
2121

2222
.. include:: /includes/language-compatibility-table-java.rst

source/faq.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Why are there two types of ``MongoClient`` in the Java driver?
1818

1919
There are two types of ``MongoClient`` because we wanted a cleaner API
2020
for new users that didn't have the confusion of including multiple CRUD
21-
API's. We wanted to ensure that the new CRUD API was available in a Java
21+
APIs. We wanted to ensure that the new CRUD API was available in a Java
2222
package structure that would work well with Java module support
2323
introduced in Java 9.
2424

@@ -31,7 +31,7 @@ New applications should generally use the
3131
- Configuration with ``MongoClientSettings`` and ``ConnectionString``. You can create instances of this interface via factory methods defined in the ``com.mongodb.client.MongoClients`` class.
3232
- CRUD API using ``MongoDatabase``, and from there, ``MongoCollection``
3333

34-
You should use ``com.mongodb.MongoClient`` class if you require support for the legacy API, which supports:
34+
You should use the ``com.mongodb.MongoClient`` class if you require support for the legacy API, which supports:
3535

3636
- Configuration with ``MongoClientOptions`` and ``MongoClientURI``
3737
- CRUD API using ``DB``, and from there, ``DBCollection``. You can access this API via the ``getDB()`` method.
@@ -77,7 +77,7 @@ document (in case you embed sub-documents).
7777

7878
For example, if you have an ``Event`` class, that you extend in Java (e.g.
7979
``MachineEvent`` or ``NetworkEvent``), using the discriminator identifies
80-
which class the PojoCodec should use to serialize/deserialize the
80+
which class the ``PojoCodec`` should use to serialize/deserialize the
8181
document.
8282

8383
Can I control serialization of ``LocalDate``?
@@ -105,12 +105,12 @@ and before the ``PojoCodecProvider``:
105105
Can I make POJOs read/write directly to the field and not use the getters/setters at all?
106106
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107107

108-
You can configure the PojoCodecProvider to use the
108+
You can configure the ``PojoCodecProvider`` to use the
109109
``SET_PRIVATE_FIELDS_CONVENTION``, which sets a private field through
110110
reflection if no public setter is available.
111111

112-
Can I mix private, protected and public setters and getters?
113-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112+
Can I mix private, protected, and public setters and getters?
113+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114114

115115
No. The native POJO codec assumes that getters/setters have the same
116116
modifiers for each field.
@@ -131,7 +131,7 @@ there is none at the moment.
131131
How do I specify the collection name for a particular POJO class? Is there an annotation?
132132
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133133

134-
There is no annotation. We recommend adding a static in your class as shown:
134+
There is no annotation. We recommend adding a static string in your class as shown:
135135

136136
.. code-block:: java
137137

source/fundamentals/aggregation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ executed) and rejected plans.
170170
.. include:: /includes/fundamentals/explain-verbosity.rst
171171

172172
In the following example, we print the JSON representation of the
173-
winning plan for aggregation stages that produce execution plans:
173+
winning plans for aggregation stages that produce execution plans:
174174

175175
.. literalinclude:: /includes/fundamentals/code-snippets/AggTour.java
176176
:language: java

source/fundamentals/gridfs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ method as shown below:
102102
.. note::
103103

104104
When you call ``create()``, MongoDB does not create the bucket if it
105-
does not exist. Instead, MongoDB creates the bucket as necssary such
105+
does not exist. Instead, MongoDB creates the bucket as necessary such
106106
as when you upload your first file.
107107

108108
For more information on the classes and methods mentioned in this section,

source/fundamentals/indexes.txt

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,26 @@ index to limit the number of documents it must inspect.
2424

2525
Indexes also:
2626

27-
- allow efficient sorting
28-
- enable special capabilities like :ref:`geospatial <geo-indexes>` search
29-
- allow adding constraints to ensure a field value is :ref:`unique <unique-indexes>`
30-
- and :manual:`more </indexes/>`
27+
- Allow efficient sorting
28+
- Enable special capabilities like :ref:`geospatial <geo-indexes>` search
29+
- Allow adding constraints to ensure a field value is :ref:`unique <unique-indexes>`
30+
- And :manual:`more </indexes/>`
3131

3232
.. tip::
3333

34-
Indexes are also used by update operations when finding the document(s) to update, delete operations when finding the
35-
document(s) to delete, and by :manual:`certain stages </core/aggregation-pipeline/#pipeline-operators-and-indexes>` in
34+
Indexes are also used by update operations when finding the documents to update, delete operations when finding the
35+
documents to delete, and by :manual:`certain stages </core/aggregation-pipeline/#pipeline-operators-and-indexes>` in
3636
the aggregation framework.
3737

3838
Query Coverage and Performance
3939
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4040

4141
When you execute a query against MongoDB, your command can include various elements:
4242

43-
- query criteria that specify field(s) and value(s) you are looking for
44-
- options that affect the query's execution (e.g. read concern)
45-
- projection criteria to specify the fields MongoDB should return (optional)
46-
- sort criteria to specify the order documents will be returned from MongoDB (optional)
43+
- Query criteria that specify fields and values you are looking for
44+
- Options that affect the query's execution (e.g. read concern)
45+
- Projection criteria to specify the fields MongoDB should return (optional)
46+
- Sort criteria to specify the order documents will be returned from MongoDB (optional)
4747

4848
When all the fields specified in the query, projection, and sort are in the same index, MongoDB returns results directly
4949
from the index, also called a **covered query**.
@@ -52,7 +52,7 @@ from the index, also called a **covered query**.
5252

5353
Sort criteria must match or invert the order of the index.
5454

55-
Consider an index on the field ``name`` in ascending order (A-Z), ``age`` in descending order (9-0):
55+
Consider an index on the field ``name`` in ascending order (A-Z) and ``age`` in descending order (9-0):
5656

5757
.. code-block:: none
5858
:copyable: false
@@ -103,8 +103,8 @@ most common index types and provide sample code for creating each index type. Fo
103103
includes static factory methods to create index specification documents for different MongoDB Index key types.
104104

105105
The following examples use the
106-
:java-docs:`createIndex <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createIndex(org.bson.conversions.Bson,com.mongodb.client.model.IndexOptions)>`
107-
to create various indexes, and the following setup:
106+
:java-docs:`createIndex() <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createIndex(org.bson.conversions.Bson,com.mongodb.client.model.IndexOptions)>`
107+
method to create various indexes, and the following setup:
108108

109109
.. literalinclude:: /includes/fundamentals/code-snippets/IndexPage.java
110110
:language: java
@@ -243,7 +243,7 @@ language as an option when creating the index.
243243

244244
.. tip::
245245

246-
Text indexes differ from the more powerful :atlas:`Atlas full text search indexes </atlas-search/>` Atlas users
246+
Text indexes differ from the more powerful :atlas:`Atlas full text search indexes </atlas-search/>`. Atlas users
247247
should use Atlas search.
248248

249249
.. common-content-end
@@ -298,14 +298,14 @@ Geospatial Indexes
298298

299299
.. _geo-indexes:
300300

301-
MongoDB supports queries of geospatial coordinate data using **2dsphere indexes**. With a 2dsphere index, you can query
301+
MongoDB supports queries of geospatial coordinate data using **2dsphere indexes**. With a ``2dsphere`` index, you can query
302302
the geospatial data for inclusion, intersection, and proximity. For more information on querying geospatial data, see
303303
:manual:`Geospatial Queries </geospatial-queries/>`.
304304

305-
To create a 2dsphere index, you must specify a field that contains only **GeoJSON objects**. For more details on this
305+
To create a ``2dsphere`` index, you must specify a field that contains only **GeoJSON objects**. For more details on this
306306
type, see the MongoDB server manual page on :manual:`GeoJSON objects </reference/geojson>`.
307307

308-
The ``location.geo`` field in following sample document from the ``theaters`` collection in the ``sample_mflix``
308+
The ``location.geo`` field in the following sample document from the ``theaters`` collection in the ``sample_mflix``
309309
database is a GeoJSON Point object that describes the coordinates of the theater:
310310

311311
.. code-block:: javascript
@@ -334,7 +334,7 @@ The following example creates a ``2dsphere`` index on the ``location.geo`` field
334334

335335
.. warning::
336336

337-
Attemping to create a geospatial index on a field that is covered by a geospatial index will result in an error.
337+
Attempting to create a geospatial index on a field that is covered by a geospatial index will result in an error.
338338

339339
.. common-content-end
340340
.. driver-content-begin
@@ -358,7 +358,7 @@ The following is an example of a geospatial query using the "location.geo" index
358358

359359
MongoDB also supports ``2d`` indexes for calculating distances on a Euclidean plane and for working with the "legacy
360360
coordinate pairs" syntax used in MongoDB 2.2 and earlier. See the :manual:`Geospatial Queries page </geospatial-queries>`
361-
in the MongoDB server manual for more further information.
361+
in the MongoDB server manual for more information.
362362

363363
Unique Indexes
364364
~~~~~~~~~~~~~~
@@ -382,14 +382,15 @@ The following example creates a unique, descending index on the ``theaterId`` fi
382382

383383
.. warning::
384384

385-
Attempting to perform a write operation that stores a duplicate value that violates the unique index, the MongoDB
385+
If you perform a write operation that stores a duplicate value that violates the unique index, the MongoDB
386386
Java driver will raise a ``DuplicateKeyException``, and MongoDB will throw an error resembling the following:
387387

388-
.. code-block:: none
388+
.. code-block:: none
389389

390-
E11000 duplicate key error index
390+
E11000 duplicate key error index
391391

392392
Refer to the :manual:`Unique Indexes page </core/index-unique>` in the MongoDB server manual for more information.
393+
393394
.. driver-content-end
394395

395396
Remove an Index

source/fundamentals/logging.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ can't find the ``slf4j-api`` artifact, the driver logs the following warning wit
6464
To set up a logger, you must include the following in your project.
6565

6666
* The ``slf4j-api`` artifact
67-
* a logging framework
68-
* a **binding**
67+
* A logging framework
68+
* A **binding**
6969

7070
.. note::
7171

@@ -367,7 +367,7 @@ its own. You can think of this as similar to class inheritance in Java.
367367

368368
The MongoDB Java driver defines the following logger names to organize different
369369
logging events in the driver. Here are the logger names defined in the driver
370-
and the logging events they correspond with.
370+
and the logging events they correspond to.
371371

372372
* ``org.mongodb.driver.authenticator`` : authentication
373373
* ``org.mongodb.driver.client`` : events related to ``MongoClient`` instances

source/fundamentals/monitoring.txt

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ The above code snippet should produce output that looks like this:
363363
.. code-block:: none
364364
:copyable: false
365365

366-
Navigate to JConcole to see your connection pools...
366+
Navigate to JConsole to see your connection pools...
367367

368368
Once you have started your server, open JConsole in your terminal using the
369369
following command:
@@ -391,10 +391,6 @@ Oracle:
391391
- `JConsole Documentation <https://www.oracle.com/technical-resources/articles/java/jconsole.html>`__.
392392
- `Monitoring and Management Guide <https://docs.oracle.com/en/java/javase/16/management/monitoring-and-management-using-jmx-technology.html>`__
393393

394-
For more information on the classes and methods mentioned in this section, see
395-
the following API Documentation:
396-
397-
- :java-docs:`JMXConnectionPoolListener <apidocs/mongodb-driver-core/com/mongodb/management/JMXConnectionPoolListener.html>`
398-
- `getPlatformMBeanServer() <https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/ManagementFactory.html#getPlatformMBeanServer()>`__
399-
- `JMXConnectorServer <https://docs.oracle.com/en/java/javase/16/docs/api/java.management/javax/management/remote/JMXConnectorServer.html>`__
400-
394+
For more information on the ``JMXConnectionPoolListener`` class, see
395+
the API Documentation for
396+
:java-docs:`JMXConnectionPoolListener <apidocs/mongodb-driver-core/com/mongodb/management/JMXConnectionPoolListener.html>`.

source/includes/fundamentals/code-snippets/IndexPage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ private void multiKeyIndex() {
9898
private void textIndex() {
9999
System.out.println("text index");
100100
// begin text index
101-
// create a text index of the "fullplot" field in the "movies" collection
101+
// create a text index of the "plot" field in the "movies" collection
102102
// if a text index already exists with a different configuration, this will
103103
// error
104104
try {

source/includes/fundamentals/code-snippets/JMXMonitoring.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public static void main(String[] args) throws InterruptedException {
1919
.build();
2020
MongoClient mongoClient = MongoClients.create(settings);
2121
try {
22-
System.out.println("Navigate to JConcole to see your connection pools...");
22+
System.out.println("Navigate to JConsole to see your connection pools...");
2323
Thread.sleep(Long.MAX_VALUE);
2424
} catch (Exception e) {
2525
e.printStackTrace();

source/issues-and-help.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ driver, please open a case in our issue management tool, JIRA:
2525

2626
* `Create an account and login <https://jira.mongodb.org>`_.
2727
* Navigate to `the JAVA project <https://jira.mongodb.org/browse/JAVA>`_.
28-
* Click **Create Issue**. Please provide as much information as possible
28+
* Click :guilabel:`Create`. Please provide as much information as possible
2929
about the issue and the steps to reproduce it.
3030

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

0 commit comments

Comments
 (0)