Skip to content

Commit 3264b9f

Browse files
authored
DOCSP-26150 Replace :doc: with :method: / :command: where possible (#2074)
* Date() * internal review feedback * internal review feedback * internal review
1 parent 21a06a2 commit 3264b9f

16 files changed

+71
-78
lines changed

source/core/replica-set-oplog.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,8 @@ Replication Lag and Flow Control
203203
Under various exceptional situations, updates to a :term:`secondary's
204204
<secondary>` oplog might lag behind the desired performance time. Use
205205
:method:`db.getReplicationInfo()` from a secondary member and the
206-
:doc:`replication status </reference/method/db.getReplicationInfo>`
207-
output to assess the current state of replication and determine if
208-
there is any unintended replication delay.
206+
replication status output to assess the current state of replication and
207+
determine if there is any unintended replication delay.
209208

210209
.. include:: /includes/extracts/4.2-changes-flow-control-general-desc.rst
211210

source/faq/concurrency.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ methods:
8787
MongoDB Enterprise Advanced
8888
</mongodb-enterprise-advanced?tck=docs_server>`
8989

90-
Specifically, the :serverstatus:`locks` document in the :doc:`output of
91-
serverStatus </reference/command/serverStatus>`, or the :data:`~currentOp.locks` field
92-
in the :doc:`current operation reporting </reference/method/db.currentOp>`
90+
Specifically, the :serverstatus:`locks` document in the :ref:`output of
91+
serverStatus <server-status-output>`, or the :data:`~currentOp.locks`
92+
field in the :method:`current operation reporting <db.currentOp>`
9393
provides insight into the type of locks and amount of lock
9494
contention in your :binary:`~bin.mongod` instance.
9595

source/includes/fact-bulkwrite-operation-batches.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ less than or equal to the value of the limit. For example, with the
1414
.. note::
1515

1616
The driver only divides the group into smaller groups when using
17-
the high-level API. If using
18-
:doc:`db.runCommand() </reference/method/db.runCommand/>` directly
17+
the high-level API. If using :method:`db.runCommand()` directly
1918
(for example, when writing a driver), MongoDB throws an error when
2019
attempting to execute a write batch which exceeds the limit.
2120

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
Index builds may be initiated either by a user command
2-
such as :doc:`Create Index </reference/method/db.collection.createIndex/>`
3-
or by an administrative process such as an
4-
:doc:`initial sync </core/replica-set-sync>`.
5-
Both are subject to the limit set by
6-
:parameter:`maxIndexBuildMemoryUsageMegabytes`.
1+
Index builds may be initiated either by a user command such as
2+
:dbcommand:`createIndexes` or by an administrative process such as an
3+
:ref:`initial sync <replica-set-sync>`. Both are subject to the limit
4+
set by :parameter:`maxIndexBuildMemoryUsageMegabytes`.
75

8-
An :doc:`initial sync operation </core/replica-set-sync>` populates
9-
only one collection at a time and has no risk of exceeding the memory
10-
limit. However, it is possible for a user to start index
11-
builds on multiple collections in multiple databases simultaneously
12-
and potentially consume an amount of memory greater than the limit
13-
set in :parameter:`maxIndexBuildMemoryUsageMegabytes`.
6+
An :ref:`initial sync <replica-set-sync>` populates only one collection
7+
at a time and has no risk of exceeding the memory limit. However, it is
8+
possible for a user to start index builds on multiple collections in
9+
multiple databases simultaneously and potentially consume an amount of
10+
memory greater than the limit set by
11+
:parameter:`maxIndexBuildMemoryUsageMegabytes`.
1412

1513
.. tip::
1614

1715
To minimize the impact of building an index on replica sets and
1816
sharded clusters with replica set shards, use a rolling index build
19-
procedure as described on
20-
:doc:`/tutorial/build-indexes-on-replica-sets`.
17+
procedure as described on :ref:`Rolling Index Builds on Replica Sets
18+
<index-building-replica-sets>`.

source/includes/warning-possible-data-loss-body.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
There is a small chance of data loss when using dollar (``$``) prefixed
22
field names or field names that contain periods (``.``) if these
33
field names are used in conjunction with unacknowledged writes
4-
(:doc:`write concern </reference/write-concern>` ``w=0``) on servers
4+
(:ref:`write concern <write-concern>` ``w=0``) on servers
55
that are older than MongoDB 5.0.
66

7-
When running :doc:`insert </tutorial/insert-documents>`,
8-
:doc:`update </tutorial/insert-documents>`, and
9-
:doc:`findAndModify </reference/method/db.collection.findAndModify>`
10-
commands, drivers that are 5.0 compatible remove restrictions on
11-
using documents with field names that are dollar (``$``) prefixed or
12-
that contain periods (``.``). These field names generated a client-side
13-
error in earlier driver versions.
7+
When running :dbcommand:`insert`, :dbcommand:`update`, and
8+
:dbcommand:`findAndModify` commands, drivers that are 5.0 compatible
9+
remove restrictions on using documents with field names that are
10+
dollar (``$``) prefixed or that contain periods (``.``). These field
11+
names generated a client-side error in earlier driver versions.
1412

1513
The restrictions are removed regardless of the server version the
1614
driver is connected to. If a 5.0 driver sends a document to an older

source/reference/method/db.collection.bulkWrite.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ Definition
7575

7676
- document
7777

78-
- Optional. A document expressing the :doc:`write concern
79-
</reference/write-concern>`. Omit to use the default write concern.
78+
- Optional. A document expressing the :ref:`write concern
79+
<write-concern>`. Omit to use the default write concern.
8080

8181
.. include:: /includes/extracts/transactions-operations-write-concern.rst
8282

@@ -207,7 +207,7 @@ updateOne and updateMany
207207
- A document that only contains :ref:`update operator
208208
<update-operators>` expressions.
209209

210-
- An :doc:`aggregation pipeline </core/aggregation-pipeline>` ``[
210+
- An :ref:`aggregation pipeline <aggregation-pipeline>` ``[
211211
<stage1>, <stage2>, ... ]`` that specifies the modifications to
212212
perform.
213213

@@ -230,7 +230,7 @@ updateOne and updateMany
230230

231231
* - ``hint``
232232

233-
- Optional. The :doc:`index </indexes>` to use to support the
233+
- Optional. The :ref:`index <indexes>` to use to support the
234234
update ``filter``. If you specify an index that does not exist,
235235
the operation errors.
236236

@@ -278,7 +278,7 @@ matching document only.
278278
* - ``replacement``
279279

280280
- The replacement document. The document cannot contain
281-
:doc:`update operators </reference/operator/update>`.
281+
:ref:`update operators <update-operators>`.
282282

283283
* - ``upsert``
284284

@@ -292,7 +292,7 @@ matching document only.
292292

293293
* - ``hint``
294294

295-
- Optional. The :doc:`index </indexes>` to use to support the
295+
- Optional. The :ref:`index <indexes>` to use to support the
296296
update ``filter``. If you specify an index that does not exist,
297297
the operation errors.
298298

@@ -477,7 +477,7 @@ Error Handling
477477
exception on errors (unless the operation is part of a transaction on
478478
MongoDB 4.0). See :ref:`bulkwrite-error-handling-txn`.
479479

480-
Excluding :doc:`/reference/write-concern` errors, ordered operations
480+
Excluding :ref:`write concern <write-concern>` errors, ordered operations
481481
stop after an error, while unordered operations continue to process any
482482
remaining write operations in the queue, unless when run inside a
483483
transaction. See :ref:`bulkwrite-error-handling-txn`.

source/reference/method/db.collection.insertMany.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ Definition
5757

5858
- document
5959

60-
- Optional. A document expressing the :doc:`write concern
61-
</reference/write-concern>`. Omit to use the default write concern.
60+
- Optional. A document expressing the :ref:`write concern
61+
<write-concern>`. Omit to use the default write concern.
6262

6363
.. include:: /includes/extracts/transactions-operations-write-concern.rst
6464

@@ -137,9 +137,9 @@ Error Handling
137137

138138
Inserts throw a ``BulkWriteError`` exception.
139139

140-
Excluding :doc:`/reference/write-concern` errors, ordered operations stop
141-
after an error, while unordered operations continue to process any
142-
remaining write operations in the queue.
140+
Excluding :ref:`write concern <write-concern>` errors, ordered
141+
operations stop after an error, while unordered operations continue to
142+
process any remaining write operations in the queue.
143143

144144
Write concern errors are displayed in the ``writeConcernErrors`` field, while
145145
all other errors are displayed in the ``writeErrors`` field. If an error is

source/reference/operator/aggregation/dateAdd.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Definition
1717

1818
.. versionadded:: 5.0
1919

20-
Increments a :doc:`Date </reference/method/Date>` object by a
20+
Increments a :method:`Date()` object by a
2121
specified number of time units.
2222

2323
The :expression:`$dateAdd` expression has the following syntax:
@@ -33,10 +33,10 @@ Definition
3333
}
3434
}
3535

36-
Returns a :doc:`Date </reference/method/Date>`. The ``startDate``
37-
can be any expression that resolves to type Date, Timestamp or
38-
ObjectId. No matter which data type is used as input, the value
39-
returned will be a :doc:`Date </reference/method/Date>` object.
36+
Returns a ``Date()``. The ``startDate`` can be any expression that
37+
resolves to type Date, Timestamp or ObjectId. No matter which data
38+
type is used as input, the value returned will be a
39+
``Date()`` object.
4040

4141
.. list-table::
4242
:header-rows: 1

source/reference/operator/aggregation/dateFromString.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Definition
4141
* - ``dateString``
4242

4343
- The date/time string to convert to a date object. See
44-
:doc:`Date </reference/method/Date>` for
44+
:method:`Date()` for
4545
more information on date/time formats.
4646

4747
.. note::

source/reference/operator/aggregation/dateSubtract.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Definition
1717

1818
.. versionadded:: 5.0
1919

20-
Decrements a :doc:`Date </reference/method/Date>` object by a
20+
Decrements a :method:`Date()` object by a
2121
specified number of time units.
2222

2323
The :expression:`$dateSubtract` expression has the following syntax:
@@ -33,10 +33,10 @@ Definition
3333
}
3434
}
3535

36-
Returns a :doc:`Date </reference/method/Date>`. The ``startDate``
37-
can be any expression that resolves to type Date, Timestamp or
38-
ObjectId. No matter which data type is used as input, the value
39-
returned will be a :doc:`Date </reference/method/Date>` object.
36+
Returns a ``Date()``. The ``startDate`` can be any expression that
37+
resolves to type Date, Timestamp or ObjectId. No matter which data
38+
type is used as input, the value returned will be a ``Date()``
39+
object.
4040

4141
.. list-table::
4242
:header-rows: 1

0 commit comments

Comments
 (0)