Skip to content

Commit 6d63abc

Browse files
authored
DOCSP-42109 Cleanup (mongodb#42)
* DOCSP-42109 Cleanup * last two errors in ticket * finish going through todos * more * constant change * review comments
1 parent b7835c0 commit 6d63abc

File tree

12 files changed

+44
-51
lines changed

12 files changed

+44
-51
lines changed

source/agg-exp-ops.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,7 @@ how to include your expression in common aggregates builder methods:
111111
- ``project(fields(computed("<field name>", <expression>)))``
112112
- ``group(<expression>)``
113113

114-
.. TODO To learn more about these methods, see the
115-
.. :ref:`kotlin-sync-aggregation`.
114+
To learn more about these methods, see the :ref:`kotlin-sync-aggregation` guide.
116115

117116
Constructor Methods
118117
-------------------
@@ -208,7 +207,8 @@ pipeline to the ``aggregate()`` method of ``MongoCollection``.
208207
aggregation, you must define the entire expression using the BSON ``Document``
209208
type.
210209

211-
.. TODO add to note To learn more about the ``Document`` type, see :ref:`<kotlin-sync-document-format>`.
210+
.. TODO Add to note once Kotlin Sync Document ata format page is written:
211+
.. To learn more about the ``Document`` type, see the :ref:`<kotlin-sync-document-format>` guide.
212212

213213
Arithmetic Operations
214214
~~~~~~~~~~~~~~~~~~~~~

source/compatibility.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The first column lists the driver version.
2727

2828
.. sharedinclude:: dbx/lifecycle-schedule-callout.rst
2929

30-
.. include:: /includes/mongodb-compatibility-table-kotlin-sync.rst
30+
.. sharedinclude:: dbx/mongodb-compatibility-table-kotlin.rst
3131

3232
The driver does not support older versions of MongoDB.
3333

@@ -37,7 +37,7 @@ For more information on how to read the compatibility table, see our guide on
3737
Language Compatibility
3838
----------------------
3939

40-
The MongoDB Kotlin Sync driver requires Kotlin 1.8 or later.
40+
The {+driver-long+} requires Kotlin 1.8 or later.
4141

4242
How to Get Help
4343
---------------

source/connect/stable-api.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@ In this guide, you can learn how to specify **{+stable-api+}** compatibility whe
2828
connecting to a MongoDB deployment.
2929

3030
The {+stable-api+} feature forces the server to run operations with behaviors compatible
31-
with the API version you specify. When you update either your driver or server,
32-
the API version changes, which can change the way these operations behave.
33-
Using the {+stable-api+} ensures consistent responses from the server and
34-
provides long-term API stability for your application.
31+
with the API version you specify. Using the {+stable-api+} ensures consistent responses
32+
from the server and provides long-term API stability for your application.
3533

3634
The following sections describe how you can enable and customize {+stable-api+} for
3735
your MongoDB client. For more information about the {+stable-api+}, including a list of
@@ -122,7 +120,7 @@ option to ``False`` when constructing your ``ServerApi`` object.
122120
API Documentation
123121
-----------------
124122

125-
For more information about using the {+stable-api+} with {+driver-short+}, see the
123+
For more information about using the {+stable-api+} with the {+driver-short+}, see the
126124
following API documentation:
127125

128126
- `ServerApi <{+core-api+}/com/mongodb/ServerApi.html>`__

source/data-formats/bson.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,9 @@ your project.
5656
project, then you can skip this step. This is because the BSON library is already
5757
included as a required dependency of the driver.
5858

59-
.. TODO: For instructions on how to add the
60-
.. MongoDB Kotlin driver as a dependency to your project, see the
61-
.. :ref:`driver installation <kotlin-sync-download-install>` section of our Get Started
62-
.. guide.
59+
For instructions on how to add the {+driver-long+} as a dependency to your project, see the
60+
:ref:`driver installation <kotlin-sync-download-install>` section of our Get Started
61+
guide.
6362

6463
We recommend that you use the `Maven <https://maven.apache.org/>`__ or
6564
`Gradle <https://gradle.org/>`__ build automation tool to manage your {+language+}

source/data-formats/serialization.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ We recommend installing the ``bson-kotlinx`` library to support
3636
custom codecs that have configurations to encode defaults, nulls, and
3737
define class discriminators.
3838

39-
.. TODO fix the link in the following note
39+
.. TODO fix the link in the following note about Codecs (page soon coming)
4040

4141
.. note::
4242

source/data-formats/time-series.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ series data:
4646
- Monthly rent price
4747
- Location, currency
4848

49-
.. _cpp-time-series-create:
49+
.. _kotlin-sync-time-series-create:
5050

5151
Create a Time Series Collection
5252
-------------------------------
@@ -119,11 +119,10 @@ You can insert data into a time series collection by using the ``insertOne()``
119119
or ``insertMany()`` methods and specifying the measurement, timestamp, and metadata
120120
in each inserted document.
121121

122-
.. TODO: Uncomment when insert guide is created
123-
.. .. tip::
122+
.. tip::
124123

125-
.. To learn more about inserting documents into a collection, see the :ref:`kotlin-sync-write-insert`
126-
.. guide.
124+
To learn more about inserting documents into a collection, see the :ref:`kotlin-sync-write-insert`
125+
guide.
127126

128127
Example
129128
~~~~~~~
@@ -166,8 +165,8 @@ following {+mdb-server+} manual entries:
166165

167166
To learn more about performing read operations, see :ref:`kotlin-sync-read`.
168167

169-
.. TODO: To learn more about performing aggregation operations, see the :ref:`kotlin-sync-aggregation`
170-
.. guide.
168+
To learn more about performing aggregation operations, see the :ref:`kotlin-sync-aggregation`
169+
guide.
171170

172171
API Documentation
173172
~~~~~~~~~~~~~~~~~

source/get-started/create-a-connection-string.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ The connection string includes the hostname or IP address and
1313
port of your deployment, the authentication mechanism, user credentials
1414
when applicable, and connection options.
1515

16-
.. TODO To connect to an instance or deployment not hosted on Atlas, see
17-
.. :ref:`kotlin-sync-connection-targets`.
16+
To connect to an instance or deployment not hosted on Atlas, see the :ref:`kotlin-sync-connection-targets` guide.
1817

1918
.. procedure::
2019
:style: connected

source/get-started/next-steps.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Learn more about the {+driver-short+} from the following resources:
1414

1515
- Learn how to perform read operations in the :ref:`<kotlin-sync-read>` section.
1616

17-
.. TODO - Learn how to perform write operations in the :ref:`<kotlin-sync-write>` section.
17+
- Learn how to perform write operations in the :ref:`<kotlin-sync-write>` section.

source/indexes.txt

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ Overview
3030
On this page, you can see copyable code examples that show how to manage different
3131
types of indexes by using the {+driver-short+}.
3232

33-
.. TODO
34-
.. .. tip::
33+
.. tip::
3534

36-
.. To learn more about working with indexes, see the :ref:`kotlin-sync-work-with-indexes`
37-
.. guide. To learn more about any of the indexes shown on this page, see the link
38-
.. provided in each section.
35+
To learn more about working with indexes, see the :ref:`kotlin-sync-work-with-indexes`
36+
guide. To learn more about any of the indexes shown on this page, see the link
37+
provided in each section.
3938

4039
To use an example from this page, copy the code example into the
4140
:ref:`sample application <kotlin-sync-index-sample>` or your own application.
@@ -78,8 +77,7 @@ The following example creates a compound index on the specified fields:
7877
:copyable:
7978
:dedent:
8079

81-
.. TODO: To learn more about compound indexes, see the :ref:`kotlin-sync-compound-index`
82-
.. guide.
80+
To learn more about compound indexes, see the :ref:`kotlin-sync-compound-index` guide.
8381

8482
Multikey Index
8583
--------------
@@ -155,7 +153,7 @@ field:
155153
:copyable:
156154
:dedent:
157155

158-
.. TODO: To learn more about wildcard indexes, see the :ref:`kotlin-sync-clustered-index`
156+
.. TODO: To learn more about clustered indexes, see the :ref:`kotlin-sync-clustered-index`
159157
.. guide.
160158

161159
Atlas Search Index Management
@@ -164,13 +162,13 @@ Atlas Search Index Management
164162
The following sections contain code examples that describe how to manage Atlas Search
165163
indexes.
166164

167-
.. TODO: To learn more about Atlas search indexes, see the :ref:`kotlin-sync-atlas-search-index`
168-
.. guide.
165+
To learn more about Atlas Search indexes, see the :ref:`kotlin-sync-atlas-search-index`
166+
guide.
169167

170168
Create Search Index
171169
~~~~~~~~~~~~~~~~~~~
172170

173-
The following example creates an Atlas search index on the specified field:
171+
The following example creates an Atlas Search index on the specified field:
174172

175173
.. literalinclude:: /includes/usage-examples/index-code-examples.kt
176174
:start-after: start-search-create
@@ -179,13 +177,13 @@ The following example creates an Atlas search index on the specified field:
179177
:copyable:
180178
:dedent:
181179

182-
.. TODO: To learn more about creating serach indexes, see the :ref:`kotlin-sync-atlas-search-index-create`
183-
.. guide.
180+
To learn more about creating serach indexes, see the :ref:`kotlin-sync-atlas-search-index-create`
181+
guide.
184182

185183
List Search Indexes
186184
~~~~~~~~~~~~~~~~~~~
187185

188-
The following example prints a list of Atlas search indexes in the specified collection:
186+
The following example prints a list of Atlas Search indexes in the specified collection:
189187

190188
.. literalinclude:: /includes/usage-examples/index-code-examples.kt
191189
:start-after: start-search-list
@@ -194,13 +192,13 @@ The following example prints a list of Atlas search indexes in the specified col
194192
:copyable:
195193
:dedent:
196194

197-
.. TODO: To learn more about listing search indexes, see the :ref:`kotlin-sync-atlas-search-index-list`
198-
.. guide.
195+
To learn more about listing search indexes, see the :ref:`kotlin-sync-atlas-search-index-list`
196+
guide.
199197

200198
Update Search Indexes
201199
~~~~~~~~~~~~~~~~~~~~~
202200

203-
The following example updates an existing Atlas search index with the specified
201+
The following example updates an existing Atlas Search index with the specified
204202
new index definition:
205203

206204
.. literalinclude:: /includes/usage-examples/index-code-examples.kt
@@ -210,13 +208,13 @@ new index definition:
210208
:copyable:
211209
:dedent:
212210

213-
.. TODO: To learn more about updating search indexes, see the :ref:`kotlin-sync-atlas-search-index-update`
214-
.. guide.
211+
To learn more about updating search indexes, see the :ref:`kotlin-sync-atlas-search-index-update`
212+
guide.
215213

216214
Delete Search Indexes
217215
~~~~~~~~~~~~~~~~~~~~~
218216

219-
The following example deletes an Atlas search index with the specified name:
217+
The following example deletes an Atlas Search index with the specified name:
220218

221219
.. literalinclude:: /includes/usage-examples/index-code-examples.kt
222220
:start-after: start-search-delete
@@ -225,8 +223,8 @@ The following example deletes an Atlas search index with the specified name:
225223
:copyable:
226224
:dedent:
227225

228-
.. TODO: To learn more about deleting search indexes, see the :ref:`kotlin-sync-atlas-search-index-drop`
229-
.. guide.
226+
To learn more about deleting search indexes, see the :ref:`kotlin-sync-atlas-search-index-drop`
227+
guide.
230228

231229
Text Index
232230
----------

source/read/retrieve.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ method takes a **query filter** and returns all matching documents. A query filt
5050
document that specifies the criteria that the driver uses to match documents from the
5151
collection.
5252

53-
.. TODO: To learn more about query filters, see :ref:`kotlin-sync-specify-query`.
53+
To learn more about query filters, see the :ref:`kotlin-sync-specify-query` guide.
5454

5555
Find Documents Example
5656
~~~~~~~~~~~~~~~~~~~~~~
@@ -157,7 +157,7 @@ for the ``FindIterable`` class.
157157
Additional Information
158158
----------------------
159159

160-
.. TODO: To learn more about query filters, see :ref:`kotlin-sync-specify-query`.
160+
To learn more about query filters, see :ref:`kotlin-sync-specify-query`.
161161

162162
To view runnable code examples that retrieve documents by using the {+driver-short+}, see
163163
:ref:`kotlin-sync-read`.

0 commit comments

Comments
 (0)