8000 fix snooty errors · nickldp/docs-kotlin@fc9147e · GitHub
[go: up one dir, main page]
Skip to content

Commit fc9147e

Browse files
mongodbenmongodben
committed
fix snooty errors
1 parent 66b121c commit fc9147e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+79
-41
lines changed

‎source/.trigger-snooty

Expand all lines: source/.trigger-snooty
Lines changed: 0 additions & 1 deletion
This file was deleted.

‎source/faq.draft.rst renamed to ‎source/faq.draft

File renamed without changes.

‎source/fundamentals/auth.draft.rst renamed to ‎source/fundamentals/auth.draft

File renamed without changes.

‎source/fundamentals/builders/aggregates.draft.rst renamed to ‎source/fundamentals/builders/aggregates.draft

File renamed without changes.

‎source/fundamentals/builders/filters.draft.rst renamed to ‎source/fundamentals/builders/filters.draft

File renamed without changes.

‎source/fundamentals/builders/indexes.draft.rst renamed to ‎source/fundamentals/builders/indexes.draft

File renamed without changes.

‎source/fundamentals/builders/projections.draft.rst renamed to ‎source/fundamentals/builders/projections.draft

File renamed without changes.

‎source/fundamentals/builders/sort.draft.rst renamed to ‎source/fundamentals/builders/sort.draft

File renamed without changes.

‎source/fundamentals/builders/updates.draft.rst renamed to ‎source/fundamentals/builders/updates.draft

File renamed without changes.

‎source/fundamentals/collations.draft.rst renamed to ‎source/fundamentals/collations.draft

File renamed without changes.

‎source/fundamentals/connection/connection-options.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,15 @@ parameters of the connection URI to specify the behavior of the client.
192192

193193
* - **authMechanism**
194194
- string
195-
- Specifies the :doc:`authentication mechanism
196-
</fundamentals/auth>` that the driver should use if a credential
195+
- Specifies the authentication mechanism
196+
that the driver should use if a credential
197197
was supplied.
198198

199+
.. TODO:(DOCSP-29261) refactor above to:
200+
.. Specifies the :doc:`authentication mechanism
201+
.. </fundamentals/auth>` that the driver should use if a credential
202+
.. was supplied.
203+
199204
| **Default**: By default, the client picks the most secure
200205
mechanism available based on the server version. For possible
201206
values, see the server documentation for the

‎source/fundamentals/connection/network-compression.draft.rst renamed to ‎source/fundamentals/connection/network-compression.draft

File renamed without changes.

‎source/fundamentals/crud/compound-operations.txt

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,9 @@ following options:
9999

100100
FoodOrder(id=1, food=donut, color=green)
101101

102-
For more information on the ``Projections`` class, see our
103-
:doc:`guide on the Projections builder </fundamentals/builders/projections/>`.
102+
.. TODO:(DOCSP-29264) add in
103+
.. For more information on the ``Projections`` class, see our
104+
.. :doc:`guide on the Projections builder </fundamentals/builders/projections/>`.
104105

105106
For more information on the upsert operation, see our
106107
:doc:`guide on upserts </fundamentals/crud/write-operations/upsert/>`.
@@ -178,8 +179,9 @@ descending sort on the ``_id`` field.
178179

179180
FoodOrder(id=2, food=pear, color=yellow)
180181

181-
For more information on the ``Sorts`` class, see our
182-
:doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
182+
.. TODO:(DOCSP-29265) add in
183+
.. For more information on the ``Sorts`` class, see our
184+
.. :doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
183185

184186
For more information about the methods and classes mentioned in this section,
185187
see the following API Documentation:
@@ -306,11 +308,13 @@ instance:
306308
Your MongoDB instance places a write lock on the document you are modifying
307309
for the duration of your compound operation.
308310

309-
For information on the ``Updates`` class, see our
310-
:doc:`guide on the Updates builder </fundamentals/builders/updates/>`.
311-
312-
For more information of the ``Filters`` class, see our
313-
:doc:`guide on the Filters builder </fundamentals/builders/filters/>`.
311+
.. TODO:(DOCSP-29266)
312+
.. For information on the ``Updates`` class, see our
313+
.. :doc:`guide on the Updates builder </fundamentals/builders/updates/>`.
314+
..
315+
.. TODO:(DOCSP-29262)
316+
.. For more information of the ``Filters`` class, see our
317+
.. :doc:`guide on the Filters builder </fundamentals/builders/filters/>`.
314318

315319
For more information on the ``findOneAndUpdate()`` method, see
316320
the API Documentation for the `MongoCollection class <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/index.html>`__.

‎source/fundamentals/crud/read-operations/geo.txt

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ GeoJSON data to a ``2dsphere`` index. The following snippet creates a
9191
.. literalinclude:: /examples/generated/GeoTest.snippet.geo2dsphere-index.kt
9292
:language: kotlin
9393

94-
For more information on the ``Indexes`` builder, see our
95-
:doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
94+
.. TODO:(DOCSP-29263) add in
95+
.. For more information on the ``Indexes`` builder, see our
96+
.. :doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
9697

9798
Coordinates on a 2D Plane
9899
-------------------------
@@ -120,8 +121,9 @@ legacy coordinate pairs to a ``2d`` index. The following snippet creates a
120121
.. literalinclude:: /examples/generated/GeoTest.snippet.geo2d-index.kt
121122
:language: kotlin
122123

123-
For more information on the ``Indexes`` builder, see our
124-
:doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
124+
.. TODO:(DOCSP-29263) add in
125+
.. For more information on the ``Indexes`` builder, see our
126+
.. :doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
125127

126128
For more information on legacy coordinate pairs, see the
127129
:manual:`MongoDB server manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
@@ -156,8 +158,9 @@ methods of the ``Filters`` builder class.
156158
For more information on geospatial query operators, see the
157159
:manual:`manual entry for geospatial queries </geospatial-queries/#geospatial-query-operators>`.
158160

159-
For more information on ``Filters``, see our
160-
:doc:`guide on the Filters builder </fundamentals/builders/filters>`.
161+
.. TODO:(DOCSP-29262) add in
162+
.. For more information on ``Filters``, see our
163+
.. :doc:`guide on the Filters builder </fundamentals/builders/filters>`.
161164

162165
Query Parameters
163166
~~~~~~~~~~~~~~~~
@@ -248,8 +251,9 @@ meters from the Great Lawn of Central Park:
248251
For more information on the ``$near`` operator, see the
249252
:manual:`reference documentation for $near </reference/operator/query/near/#mongodb-query-op.-near>`.
250253

251-
For more information on ``Filters``, see
252-
:doc:`our guide on the Filters builder </fundamentals/builders/filters>`.
254+
.. TODO:(DOCSP-29262) add in
255+
.. For more information on ``Filters``, see
256+
.. :doc:`our guide on the Filters builder </fundamentals/builders/filters>`.
253257

254258
Query Within a Range
255259
~~~~~~~~~~~~~~~~~~~~

‎source/fundamentals/crud/read-operations/retrieve.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,13 @@ To address this scenario, the owner finds orders to match the criteria:
8383
After the owner runs this query, they find two orders that matched the
8484
criteria.
8585

86-
For more information on how to build filters, see our :doc:`Filters Builders
87-
</fundamentals/builders/filters>` guide.
86+
.. TODO:(DOCSP-29262) add in
87+
.. For more information on how to build filters, see our :doc:`Filters Builders
88+
.. </fundamentals/builders/filters>` guide.
8889

89-
For a runnable ``find()`` example, see our :doc:`Find Multiple
90-
Documents </usage-examples/find>` page.
90+
.. TODO:(DOCSP-29248) add in
91+
.. For a runnable ``find()`` example, see our :doc:`Find Multiple
92+
.. Documents </usage-examples/find>` page.
9193

9294
.. _retrieve-aggregate:
9395

‎source/fundamentals/crud/read-operations/sort.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,12 @@ largest value of the ``_id`` field as follows:
9191
In the preceding code snippets, we specify our sort criteria using the ``Sorts``
9292
builder class. While it is possible to specify sort criteria using any class
9393
that implements the ``Bson`` interface, we recommend that you specify sort
94-
criteria through the ``Sorts`` builder. For more information on the ``Sorts``
95-
builder class, see our
96-
:doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
94+
criteria through the ``Sorts`` builder.
95+
96+
.. TODO:(DOCSP-29265) add in to end of prev paragraph
97+
.. For more information on the ``Sorts``
98+
.. builder class, see our
99+
.. :doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
97100

98101
For more information about the classes and interfaces in this section, see the
99102
following API Documentation:
@@ -288,9 +291,11 @@ sort by the text score.
288291
In the following code example, we show how you can use the
289292
``Sorts.metaTextScore()`` method to sort the results of a text
290293
search on the :ref:`sample collection <sorts-crud-sort-sample>`.
291-
The code example uses the :doc:`Filters </fundamentals/builders/filters>`,
292-
:doc:`Indexes </fundamentals/builders/indexes>`, and
293-
:doc:`Projections </fundamentals/builders/projections>` builders.
294+
295+
.. TODO: add sentence back when builders section done
296+
.. The code example uses the :doc:`Filters </fundamentals/builders/filters>`,
297+
.. :doc:`Indexes </fundamentals/builders/indexes>`, and
298+
.. :doc:`Projections </fundamentals/builders/projections>` builders.
294299

295300
The code example performs the following actions:
296301

‎source/fundamentals/crud/read-operations/text.txt

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,10 @@ search.
6767
In the following examples, you run text searches on the ``title``
6868
field in the ``fast_and_furious_movies`` collection. To enable text
6969
searches on the ``title`` field, create a text index using the
70-
:ref:`Indexes <index-text-indexes>` builder with the following
71-
snippet:
70+
``Indexes`` builder with the following snippet:
71+
72+
.. TODO:(DOCSP-29263) refactor last line of above paragraph to be the following
73+
.. :ref:`Indexes <index-text-indexes>` builder with the following snippet:
7274

7375
.. literalinclude:: /examples/generated/SearchTextTest.snippet.text-index.kt
7476
:language: kotlin
@@ -84,11 +86,18 @@ Text Search
8486

8587
Use the ``Filters.text()`` method to specify a text search.
8688

87-
The ``Filters.text()`` method uses the :doc:`Filters builder
88-
</fundamentals/builders/filters>` to define a query filter specifying
89+
The ``Filters.text()`` method uses the Filters builder
90+
to define a query filter specifying
8991
what to search for during the text search. The query filter is
9092
represented by a :ref:`BSON <bson>` instance. Pass the query filter to the
91-
``find()`` method to run a text search.
93+
``find()`` method to run a text search.
94+
95+
.. TODO:(DOCSP-29262): refactor above paragraph to include the link when filters builder page added
96+
.. The ``Filters.text()`` method uses the :doc:`Filters builder
97+
.. </fundamentals/builders/filters>` to define a query filter specifying
98+
.. what to search for during the text search. The query filter is
99+
.. represented by a :ref:`BSON <bson>` instance. Pass the query filter to the
100+
.. ``find()`` method to run a text search.
92101

93102
When you execute the ``find()`` method, MongoDB runs a text search on
94103
all the fields indexed with the text index on the collection. MongoDB

‎source/fundamentals/crud/write-operations/change-a-document.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ The ``updateOne()`` and ``updateMany()`` methods both have the following
7474
parameters:
7575

7676
- ``query`` specifies a query filter with the criteria to match documents to update in your collection
77-
- ``updateDocument`` specifies the fields and values to change in the matching document or documents. For this example, we use the :doc:`Updates builder </fundamentals/builders/updates>` to create the update document.
77+
- ``updateDocument`` specifies the fields and values to change in the matching document or documents.
78+
79+
.. TODO(DOCSP-29266): add back to above bullet point when updates builder page ready.
80+
.. For this example, we use the :doc:`Updates builder </fundamentals/builders/updates>` to create the update document.
7881

7982
You can create the ``updateDocument`` using an ``Updates`` builder as
8083
follows:

‎source/fundamentals/crud/write-operations/embedded-arrays.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ Specifying an Update
5151

5252
To specify an update, use the ``Updates`` builder. The ``Updates``
5353
builder provides static utility methods to construct update
54-
specifications. For more information on using the ``Updates`` builder with
55-
arrays, see our :ref:`guide on the Updates builder <array_updates>`.
54+
specifications.
55+
56+
.. TODO:(DOCSP-29266) add in
57+
.. For more information on using the ``Updates`` builder with
58+
.. arrays, see our :ref:`guide on the Updates builder <array_updates>`.
5659

5760
The following example performs these actions:
5861

‎source/fundamentals/crud/write-operations/insert.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ see the following resources:
9494
- `insertOne() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/insert-one.html>`__ API Documentation
9595
- `InsertOneResult <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/result/InsertOneResult.html>`__ API Documentation
9696
- Manual Explanation on :manual:`insertOne() </reference/method/db.collection.insertOne/>`
97-
- Runnable :doc:`Insert a Document Example </usage-examples/insertOne>`
97+
98+
.. TODO(DOCSP-29251): add back
99+
.. - Runnable :doc:`Insert a Document Example </usage-examples/insertOne>`
98100

99101
Insert Multiple Documents
100102
-------------------------
@@ -167,7 +169,9 @@ see the following resources:
167169
- `insertMany() <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/insert-many.html>`__ API Documentation
168170
- `InsertManyResult <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/result/InsertManyResult.html>`__ API Documentation
169171
- Manual Explanation on :manual:`insertMany() </reference/method/db.collection.insertMany/>`
170-
- Runnable :doc:`Insert Multiple Documents Example </usage-examples/insertMany>`
172+
173+
.. TODO(DOCSP-29251): add back
174+
.. - Runnable :doc:`Insert Multiple Documents Example </usage-examples/insertMany>`
171175

172176
Summary
173177
-------

‎source/fundamentals/data-formats/codecs.draft.rst renamed to ‎source/fundamentals/data-formats/codecs.draft

File renamed without changes.

‎source/fundamentals/enterprise-auth.draft.rst renamed to ‎source/fundamentals/enterprise-auth.draft

File renamed without changes.

‎source/fundamentals/gridfs.draft.rst renamed to ‎source/fundamentals/gridfs.draft

File renamed without changes.

‎source/fundamentals/time-series.draft.rst renamed to ‎source/fundamentals/time-series.draft

File renamed without changes.

‎source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ MongoDB driver for server-side Kotlin applications using coroutines. Download it
2727
following our Quick Start guide.
2828

2929
If your Kotlin application requires synchronous processing, use the
30-
:driver:`Sync Driver <TODO:(DOCSP-29157)>` which uses synchronous operations
30+
:driver:`Sync Driver <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-sync/>` which uses synchronous operations
3131
to make blocking calls to MongoDB.
3232

3333
Quick Start

‎source/usage-examples.draft.rst renamed to ‎source/usage-examples.draft

File renamed without changes.

‎source/usage-examples/bulkWrite.draft.rst renamed to ‎source/usage-examples/bulkWrite.draft

File renamed without changes.

‎source/usage-examples/command.draft.rst renamed to ‎source/usage-examples/command.draft

File renamed without changes.

‎source/usage-examples/count.draft.rst renamed to ‎source/usage-examples/count.draft

File renamed without changes.

‎source/usage-examples/delete-operations.draft.rst renamed to ‎source/usage-examples/delete-operations.draft

File renamed without changes.

‎source/usage-examples/deleteMany.draft.rst renamed to ‎source/usage-examples/deleteMany.draft

File renamed without changes.

‎source/usage-examples/deleteOne.draft.rst renamed to ‎source/usage-examples/deleteOne.draft

File renamed without changes.

‎source/usage-examples/distinct.draft.rst renamed to ‎source/usage-examples/distinct.draft

File renamed without changes.

‎source/usage-examples/find-operations.draft.rst renamed to ‎source/usage-examples/find-operations.draft

File renamed without changes.

‎source/usage-examples/find.draft.rst renamed to ‎source/usage-examples/find.draft

File renamed without changes.

‎source/usage-examples/findOne.draft.rst renamed to ‎source/usage-examples/findOne.draft

File renamed without changes.

‎source/usage-examples/insert-operations.draft.rst renamed to ‎source/usage-examples/insert-operations.draft

File renamed without changes.

‎source/usage-examples/insertMany.draft.rst renamed to ‎source/usage-examples/insertMany.draft

File renamed without changes.

‎source/usage-examples/insertOne.draft.rst renamed to ‎source/usage-examples/insertOne.draft

File renamed without changes.

‎source/usage-examples/replaceOne.draft.rst renamed to ‎source/usage-examples/replaceOne.draft

File renamed without changes.

‎source/usage-examples/update-operations.draft.rst renamed to ‎source/usage-examples/update-operations.draft

File renamed without changes.

‎source/usage-examples/updateMany.draft.rst renamed to ‎source/usage-examples/updateMany.draft

File renamed without changes.

‎source/usage-examples/updateOne.draft.rst renamed to ‎source/usage-examples/updateOne.draft

File renamed without changes.

‎source/usage-examples/watch.draft.rst renamed to ‎source/usage-examples/watch.draft

File renamed without changes.

‎source/whats-new.draft.rst renamed to ‎source/whats-new.draft

File renamed without changes.

0 commit comments

Comments
 (0)
0