Skip to content

Commit 4e4d744

Browse files
Docsp 16491 typos after crud (#113)
1 parent 292320c commit 4e4d744

File tree

6 files changed

+47
-46
lines changed

6 files changed

+47
-46
lines changed

source/fundamentals/builders.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Overview
2323
--------
2424

2525
This section includes guides on how to use each of the available
26-
builders, and demonstrates the utility the Java driver builder classes
26+
builders, and demonstrates the utility the MongoDB Java driver builder classes
2727
provide.
2828

2929
The Java driver provides classes to simplify the process for developers
@@ -38,14 +38,14 @@ Using the builders class, you leverage the power of:
3838
- The Java compiler and the IDE to find errors during development
3939
- The IDE for discovery and code completion
4040

41-
The Java compiler and the IDE catch errors such as misspelled
41+
When using builders, the Java compiler and the IDE catch errors such as misspelled
4242
operators early on. When using the MongoDB shell or plain Java, you
4343
write operators as strings and get no visual indication of a problem,
4444
pushing these errors to runtime instead of compile time
4545

4646
With the builder classes, you write operators as methods. The IDE
4747
instantly underlines and gives you a red bar on the right indicating
48-
something is wrong. While developing, the IDE also shows you with the
48+
something is wrong. While developing, the IDE also shows you the
4949
methods you can use. It automatically completes your code with
5050
placeholder parameters once you select which method you want to use.
5151

source/fundamentals/builders/aggregates.txt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Skip
153153

154154
Use the ``skip()`` method to create a :manual:`$skip </reference/operator/aggregation/skip/>`
155155
pipeline stage to skip over the specified number of documents before
156-
passing documents into the stage.
156+
passing documents into the next stage.
157157

158158
The following example creates a pipeline stage that skips the first ``5`` documents:
159159

@@ -221,7 +221,7 @@ for each distinct grouping.
221221
.. tip::
222222

223223
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
224-
class with static factory methods for each of the supported accumulator.
224+
class with static factory methods for each of the supported accumulators.
225225

226226
The following example creates a pipeline stage that groups documents by the value
227227
of the ``customerId`` field. Each group accumulates the sum and average
@@ -345,7 +345,8 @@ recursion depth information for every document.
345345
:language: java
346346
:dedent:
347347

348-
Using ``GraphLookupOptions``, you can specify a filter that must match. In this
348+
Using ``GraphLookupOptions``, you can specify a filter that documents must match
349+
in order for MongoDB to include them in your search. In this
349350
example, only links with "golf" in their ``hobbies`` field will be included.
350351

351352
.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
@@ -363,7 +364,7 @@ these groups by count in descending order.
363364

364365
.. tip::
365366

366-
The ``$sortByCount`` stage is identical to a ``$group`` stage with an
367+
The ``$sortByCount`` stage is identical to a ``$group`` stage with a
367368
``$sum`` accumulator followed by a ``$sort`` stage.
368369

369370
.. code-block:: json
@@ -406,7 +407,7 @@ pipeline stage that adds new fields to documents.
406407

407408
.. tip::
408409

409-
Use the ``$addFields`` when you do not want to project field inclusion
410+
Use ``$addFields`` when you do not want to project field inclusion
410411
or exclusion.
411412

412413
Th following example adds two new fields, ``a`` and ``b`` to the input documents:
@@ -421,7 +422,7 @@ Count
421422
-----
422423

423424
Use the ``count()`` method to create a :manual:`$count </reference/operator/aggregation/count/>`
424-
pipeline stage that counts the number of documents that enter, and assigns
425+
pipeline stage that counts the number of documents that enter the stage, and assigns
425426
that value to a specified field name. If you do not specify a field,
426427
``count()`` defaults the field name to "count".
427428

@@ -472,7 +473,7 @@ into a bucket called "monster" for monstrously large screen sizes:
472473
.. tip::
473474

474475
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
475-
class with static factory methods for each of the supported accumulator.
476+
class with static factory methods for each of the supported accumulators.
476477

477478
.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
478479
:start-after: // begin bucketOptions
@@ -503,13 +504,13 @@ based scheme to set boundary values, and specify additional accumulators.
503504
The following example creates a pipeline stage that will attempt to create and evenly
504505
distribute documents into *10* buckets using the value of their ``price`` field,
505506
setting the bucket boundaries at powers of 2 (2, 4, 8, 16, ...). It also counts
506-
the number of documents in each bucket, and calculates the average their ``price``
507+
the number of documents in each bucket, and calculates their average ``price``
507508
in a new field called ``avgPrice``:
508509

509510
.. tip::
510511

511512
The driver includes the :java-docs:`Accumulators <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
512-
class with static factory methods for each of the supported accumulator:
513+
class with static factory methods for each of the supported accumulators.
513514

514515
.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
515516
:start-after: // begin bucketAutoOptions

source/fundamentals/builders/filters.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -388,16 +388,16 @@ The bitwise operator methods include:
388388
- Matches
389389

390390
* - :java-docs:`bitsAllSet() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#bitsAllSet(java.lang.String,long)>`
391-
- documents when the specified bits of a field are set (i.e. "1").
391+
- documents where the specified bits of a field are set (i.e. "1").
392392

393393
* - :java-docs:`bitsAllClear() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#bitsAllClear(java.lang.String,long)>`
394-
- documents when the specified bits of a field are clear (i.e. "0").
394+
- documents where the specified bits of a field are clear (i.e. "0").
395395

396396
* - :java-docs:`bitsAnySet() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#bitsAnySet(java.lang.String,long)>`
397-
- documents when at least one of the specified bits of a field are set (i.e. "1").
397+
- documents where at least one of the specified bits of a field are set (i.e. "1").
398398

399399
* - :java-docs:`bitsAnyClear() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#bitsAnyClear(java.lang.String,long)>`
400-
- documents when at least one of the specified bits of a field are clear (i.e. "0").
400+
- documents where at least one of the specified bits of a field are clear (i.e. "0").
401401

402402
The following example matches documents that have a ``bitField`` field
403403
with bits set at positions of the corresponding bitmask "34" (i.e.
@@ -451,13 +451,13 @@ The geospatial operator methods include:
451451
- geometries containing a geospatial data value (GeoJSON or legacy coordinate pairs) that exist within the specified circle, using spherical geometry.
452452

453453
* - :java-docs:`geoIntersects() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#geoIntersects(java.lang.String,org.bson.conversions.Bson)>`
454-
- geometries that intersect with a GeoJSON geometry. The 2dsphere index supports ``$geoIntersects``.
454+
- geometries that intersect with a GeoJSON geometry. The ``2dsphere`` index supports ``$geoIntersects``.
455455

456456
* - :java-docs:`near() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#near(java.lang.String,org.bson.conversions.Bson,java.lang.Double,java.lang.Double)>`
457-
- geospatial objects in proximity to a point. Requires a geospatial index. The 2dsphere and 2d indexes support ``$near``.
457+
- geospatial objects in proximity to a point. Requires a geospatial index. The ``2dsphere`` and ``2d`` indexes support ``$near``.
458458

459459
* - :java-docs:`nearSphere() <apidocs/mongodb-driver-core/com/mongodb/client/model/Filters.html#nearSphere(java.lang.String,org.bson.conversions.Bson,java.lang.Double,java.lang.Double)>`
460-
- geospatial objects in proximity to a point on a sphere. Requires a geospatial index. The 2dsphere and 2d indexes support ``$nearSphere``.
460+
- geospatial objects in proximity to a point on a sphere. Requires a geospatial index. The ``2dsphere`` and ``2d`` indexes support ``$nearSphere``.
461461

462462
The following example creates a filter that matches documents in which
463463
the ``point`` field contains a GeoJSON geometry that falls within

source/fundamentals/builders/indexes.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Ascending Indexes
5555
-----------------
5656

5757
An ascending index enables you to sort query results by the value of the
58-
indexed field(s) from smallest to largest.
58+
indexed fields from smallest to largest.
5959

6060
In order to create an ascending index, first call the
6161
:java-docs:`ascending() <apidocs/mongodb-driver-core/com/mongodb/client/model/Indexes.html#ascending(java.lang.String...)>`
@@ -83,7 +83,7 @@ Descending Indexes
8383
------------------
8484

8585
A descending index enables you to sort query results by the value of the
86-
indexed field(s) from largest to smallest.
86+
indexed fields from largest to smallest.
8787

8888
In order to create a descending index, first call the
8989
:java-docs:`descending() <apidocs/mongodb-driver-core/com/mongodb/client/model/Indexes.html#descending(java.lang.String...)>`
@@ -173,16 +173,16 @@ field:
173173
Geospatial Indexes
174174
------------------
175175

176-
A geo2dsphere index groups documents by the coordinates in the indexed field.
176+
A ``2dsphere`` index groups documents by the coordinates in the indexed field.
177177

178-
In order to create a geo2dsphere index, first call the
178+
In order to create a ``2dsphere`` index, first call the
179179
:java-docs:`geo2dsphere() <apidocs/mongodb-driver-core/com/mongodb/client/model/Indexes.html#geo2dsphere(java.lang.String...)>`
180180
builder method to create a ``Bson`` instance that represents the index
181181
document, passing the name or names of the fields you want to index.
182182
Then, call the ``createIndex()`` method on the collection, passing the ``Bson``
183183
instance that contains the index document.
184184

185-
The following example specifies a geo2dsphere index on the ``location`` field:
185+
The following example specifies a ``2dsphere`` index on the ``location`` field:
186186

187187
.. literalinclude:: /includes/fundamentals/code-snippets/builders/Indexes.java
188188
:language: java

source/fundamentals/builders/projections.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ The following code shows the output from this projection:
351351
Project a Text Score
352352
~~~~~~~~~~~~~~~~~~~~
353353

354-
Use the ``metaTextScore()`` method to specify a projection of
354+
Use the ``metaTextScore()`` method to specify a projection of the
355355
:manual:`score of a text query </reference/operator/query/text/#text-score>`
356356

357357
The following example projects the text score as the value of the ``score`` field:

source/fundamentals/builders/updates.txt

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ Overview
1818
In this guide, you can learn how to specify **updates** using
1919
:doc:`builders </fundamentals/builders/>` in the MongoDB Java driver.
2020

21-
Update builders provide helper methods for the following types of updates:
21+
The ``Updates`` builder provides helper methods for the following types of updates:
2222

2323
- :ref:`Field Updates <field_updates>`
2424
- :ref:`Array Updates <array_updates>`
2525
- :ref:`Combining Multiple Update Operators <multiple_updates>`
2626

2727
Some methods that expect updates are:
2828

29-
- updateOne()
30-
- updateMany()
31-
- bulkWrite()
29+
- ``updateOne()``
30+
- ``updateMany()``
31+
- ``bulkWrite()``
3232

3333
The ``Updates`` class provides static factory methods for all the MongoDB update
3434
operators. Each method returns an instance of the :ref:`Bson <bson>`
@@ -212,7 +212,7 @@ The following example renames the ``qty`` field to "quantity":
212212
:start-after: begin renameUpdate
213213
:end-before: end renameUpdate
214214

215-
The example above updates the document to the following state:
215+
The example above updates the original document to the following state:
216216

217217
.. code-block:: json
218218
:copyable: false
@@ -237,7 +237,7 @@ specified in an update operation.
237237
:start-after: begin minUpdate
238238
:end-before: end minUpdate
239239

240-
The example above updates the document to the following state:
240+
The example above updates the original document to the following state:
241241

242242
.. code-block:: json
243243
:copyable: false
@@ -265,7 +265,7 @@ maximum of its current value and "8":
265265
:start-after: begin maxUpdate
266266
:end-before: end maxUpdate
267267

268-
The example above updates the document to the following state:
268+
The example above updates the original document to the following state:
269269

270270
.. code-block:: json
271271
:copyable: false
@@ -280,9 +280,9 @@ The example above updates the document to the following state:
280280

281281
Current Date
282282
~~~~~~~~~~~~
283-
Use the :java-docs:`apidocs/mongodb-driver-core/currentDate() <com/mongodb/client/model/Updates.html#currentDate(java.lang.String)>`
283+
Use the :java-docs:`currentDate() <com/mongodb/client/model/Updates.html#currentDate(java.lang.String)>`
284284
method to assign the value of a field in an update operation to the
285-
current date as a :manual:`date </reference/bson-types/#date>`.
285+
current date as a :manual:`BSON date </reference/bson-types/#date>`.
286286

287287
The following example sets the value of the ``lastModified`` field to
288288
the current date as a BSON date:
@@ -293,7 +293,7 @@ the current date as a BSON date:
293293
:start-after: begin currentDateUpdate
294294
:end-before: end currentDateUpdate
295295

296-
The example above updates the document to the following state:
296+
The example above updates the original document to the following state:
297297

298298
.. code-block:: json
299299
:copyable: false
@@ -321,7 +321,7 @@ the current date as a BSON timestamp:
321321
:start-after: begin currentTimestampUpdate
322322
:end-before: end currentTimestampUpdate
323323

324-
The example above updates the document to the following state:
324+
The example above updates the original document to the following state:
325325

326326
.. code-block:: json
327327
:copyable: false
@@ -339,11 +339,11 @@ Bit
339339
Use the :java-docs:`bitwiseOr() <apidocs/mongodb-driver-core/com/mongodb/client/model/Updates.html#bitwiseOr(java.lang.String,int)>`,
340340
:java-docs:`bitwiseAnd() <apidocs/mongodb-driver-core/com/mongodb/client/model/Updates.html#bitwiseAnd(java.lang.String,int)>`,
341341
and :java-docs:`bitwiseXor() <apidocs/mongodb-driver-core/com/mongodb/client/model/Updates.html#bitwiseXor(java.lang.String,int)>`
342-
methods to perform a bitwise update of the integral value of a field in
342+
methods to perform a bitwise update of the integer value of a field in
343343
an update operation.
344344

345-
The following example performs a bitwise AND between the number
346-
"10" and the integral value of the ``qty`` field:
345+
The following example performs a bitwise ``AND`` between the number
346+
"10" and the integer value of the ``qty`` field:
347347

348348
.. literalinclude:: /includes/fundamentals/code-snippets/builders/Updates.java
349349
:language: java
@@ -361,7 +361,7 @@ The bitwise operation results in 15:
361361
----
362362
1111
363363

364-
The example above updates the document to the following state:
364+
The example above updates the original document to the following state:
365365

366366
.. code-block:: json
367367
:copyable: false
@@ -394,7 +394,7 @@ the ``vendor`` field:
394394
:start-after: begin addToSetUpdate
395395
:end-before: end addToSetUpdate
396396

397-
The example above updates the document to the following state:
397+
The example above updates the original document to the following state:
398398

399399
.. code-block:: json
400400
:copyable: false
@@ -423,7 +423,7 @@ of the ``vendor`` field:
423423
:start-after: begin popFirstUpdate
424424
:end-before: end popFirstUpdate
425425

426-
The example above updates the document to the following state:
426+
The example above updates the original document to the following state:
427427

428428
.. code-block:: json
429429
:copyable: false
@@ -450,7 +450,7 @@ The following example removes vendor "A" and "M" from the ``vendor`` array:
450450
:start-after: begin pullAllUpdate
451451
:end-before: end pullAllUpdate
452452

453-
The example above updates the document to the following state:
453+
The example above updates the original document to the following state:
454454

455455
.. code-block:: json
456456
:copyable: false
@@ -478,7 +478,7 @@ array:
478478
:start-after: begin pullUpdate
479479
:end-before: end pullUpdate
480480

481-
The example above updates the document to the following state:
481+
The example above updates the original document to the following state:
482482

483483
.. code-block:: json
484484
:copyable: false
@@ -504,7 +504,7 @@ The following examples pushes "C" to the ``vendor`` array:
504504
:start-after: begin pushUpdate
505505
:end-before: end pushUpdate
506506

507-
The example above updates the document to the following state:
507+
The example above updates the original document to the following state:
508508

509509
.. code-block:: json
510510
:copyable: false
@@ -534,7 +534,7 @@ the ``vendor`` field:
534534
:start-after: begin combineUpdate
535535
:end-before: end combineUpdate
536536

537-
The example above updates the document to the following state:
537+
The example above updates the original document to the following state:
538538

539539
.. code-block:: json
540540
:copyable: false

0 commit comments

Comments
 (0)