Skip to content

Commit ba6353d

Browse files
jmd-mongojmd-mongo
authored
DOCSP-26204 update instances of :doc: pointing to core/index-text with :ref: (#2087)
* DOCSP-26204 update instances of :doc: pointing to core/index-text with :ref: * internal review feedback
1 parent 08259c7 commit ba6353d

17 files changed

+51
-53
lines changed

‎source/core/index-sparse.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ ascending/descending index key(s), only the existence of the geospatial
9595
field(s) in a document determine whether the index references the
9696
document.
9797

98-
For sparse compound indexes that contain :doc:`text </core/index-text>`
98+
For sparse compound indexes that contain :ref:`text <index-feature-text>`
9999
index keys along with ascending/descending index keys, only the
100100
existence of the ``text`` index field(s) determine whether the index
101101
references a document.

‎source/includes/driver-remove-indexes-tabs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
Where the value of ``nIndexesWas`` reflects the number of indexes
3232
*before* removing this index.
3333

34-
For :doc:`text </core/index-text>` indexes, pass the index name to the
34+
For :ref:`text <index-feature-text>` indexes, pass the index name to the
3535
:method:`db.collection.dropIndex()` method. See :ref:`drop-text-index`
3636
for details.
3737

‎source/includes/driver-view-existing-indexes-tabs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
List Specific Type of Indexes
4545
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4646

47-
To list all indexes of a certain type (such as :doc:`hashed
48-
</core/index-hashed>` or :doc:`text </core/index-text>`) for all
49-
collections in all database, run the following command in
47+
To list all indexes of a certain type (such as :ref:`hashed
48+
<index-type-hashed>` or :ref:`text <index-feature-text>`) for
49+
all collections in all database, run the following command in
5050
:binary:`~bin.mongosh`:
5151

5252
.. code-block:: javascript

‎source/includes/extracts-collation.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ content: |
181181
The following indexes only support simple binary comparison and do
182182
not support :ref:`collation <collation>`:
183183
184-
- :doc:`text </core/index-text>` indexes,
184+
- :ref:`text <index-feature-text>` indexes,
185185
186186
- :doc:`2d </core/2d>` indexes, and
187187

‎source/includes/extracts-wildcard-indexes.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ content: |
8686
8787
- :doc:`Compound </core/index-compound>`
8888
- :doc:`TTL </core/index-ttl>`
89-
- :doc:`Text </core/index-text>`
89+
- :ref:`text <index-feature-text>`
9090
- :doc:`2d (Geospatial) </core/geospatial-indexes>`
9191
- :doc:`2dsphere (Geospatial) </core/2dsphere>`
9292
- :doc:`Hashed </core/index-hashed>`

‎source/reference/command/createIndexes.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ Each document in the ``indexes`` array can take the following fields:
295295
- :doc:`2dsphere </core/2dsphere>`
296296
- :doc:`2d </core/2d>`
297297
- :doc:`geoHaystack </core/geohaystack>`
298-
- :doc:`text </core/index-text>`
298+
- :ref:`text <index-feature-text>`
299299

300300
For a compound index that includes ``2dsphere`` index key(s)
301301
along with keys of other types, only the ``2dsphere`` index
@@ -364,7 +364,7 @@ Each document in the ``indexes`` array can take the following fields:
364364

365365
- document
366366

367-
- Optional. For :doc:`text </core/index-text>` indexes, a document that contains
367+
- Optional. For :ref:`text <index-feature-text>` indexes, a document that contains
368368
field and weight pairs. The weight is an integer ranging from 1 to
369369
99,999 and denotes the significance of the field relative to the
370370
other indexed fields in terms of the score. You can specify weights
@@ -378,7 +378,7 @@ Each document in the ``indexes`` array can take the following fields:
378378

379379
- string
380380

381-
- Optional. For :doc:`text </core/index-text>` indexes, the language that
381+
- Optional. For :ref:`text <index-feature-text>` indexes, the language that
382382
determines the list of stop words and the rules for the stemmer and
383383
tokenizer. See :ref:`text-search-languages` for the available
384384
languages and :doc:`/tutorial/specify-language-for-text-index` for
@@ -390,7 +390,7 @@ Each document in the ``indexes`` array can take the following fields:
390390

391391
- string
392392

393-
- Optional. For :doc:`text </core/index-text>` indexes, the name of the field, in
393+
- Optional. For :ref:`text <index-feature-text>` indexes, the name of the field, in
394394
the collection's documents, that contains the override language for
395395
the document. The default value is ``language``. See
396396
:ref:`specify-language-field-text-index-example` for an example.

‎source/reference/command/dropIndexes.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ The command takes the following fields:
6767

6868
- To drop a single index, specify either the index name,
6969
the index specification document (unless the index is a
70-
:doc:`text </core/index-text>` index), or an array of the
71-
index name. To drop a :doc:`text </core/index-text>` index,
72-
specify the index names instead of the index specification
73-
document. If this index is the last remaining shard key
74-
index, ``dropIndexes`` raises an error.
70+
:ref:`text <index-feature-text>` index), or an array of the
71+
index name. To drop a text index, specify the index names
72+
instead of the index specification document. If this index is
73+
the last remaining shard key index, ``dropIndexes`` raises an
74+
error.
7575

7676
- To drop multiple indexes (Available starting in MongoDB
7777
4.2), specify an array of the index names.
@@ -124,7 +124,7 @@ You cannot drop the default index on the ``_id`` field.
124124
text Indexes
125125
~~~~~~~~~~~~
126126

127-
To drop a :doc:`text </core/index-text>` index, specify the index name
127+
To drop a :ref:`text <index-feature-text>` index, specify the index name
128128
instead of the index specification document.
129129

130130
.. _dropIndexes-cmd-index-builds:

‎source/reference/limits.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Indexes
242242
The following index types only support simple binary comparison and
243243
do not support :ref:`collation <collation>`:
244244

245-
- :doc:`text </core/index-text>` indexes,
245+
- :ref:`text <index-feature-text>` indexes,
246246

247247
- :doc:`2d </core/2d>` indexes, and
248248

‎source/reference/method/db.collection.createIndex.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ otherwise specified:
269269
- :doc:`2dsphere </core/2dsphere>`
270270
- :doc:`2d </core/2d>`
271271
- :doc:`geoHaystack </core/geohaystack>`
272-
- :doc:`text </core/index-text>`
272+
- :ref:`text <index-feature-text>`
273273

274274
For a compound index that includes ``2dsphere`` index key(s)
275275
along with keys of other types, only the ``2dsphere`` index
@@ -390,7 +390,7 @@ Collation and Index Use
390390
Options for ``text`` Indexes
391391
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
392392

393-
The following options are available for :doc:`text </core/index-text>`
393+
The following options are available for :ref:`text <index-feature-text>`
394394
indexes only:
395395

396396

@@ -408,7 +408,7 @@ indexes only:
408408

409409
- document
410410

411-
- Optional. For :doc:`text </core/index-text>` indexes, a document that contains
411+
- Optional. For ``text`` indexes, a document that contains
412412
field and weight pairs. The weight is an integer ranging from 1 to
413413
99,999 and denotes the significance of the field relative to the
414414
other indexed fields in terms of the score. You can specify weights
@@ -423,7 +423,7 @@ indexes only:
423423

424424
- string
425425

426-
- Optional. For :doc:`text </core/index-text>` indexes, the language that
426+
- Optional. For ``text`` indexes, the language that
427427
determines the list of stop words and the rules for the stemmer and
428428
tokenizer. See :ref:`text-search-languages` for the available
429429
languages and :doc:`/tutorial/specify-language-for-text-index` for
@@ -435,7 +435,7 @@ indexes only:
435435

436436
- string
437437

438-
- Optional. For :doc:`text </core/index-text>` indexes, the name of the field, in
438+
- Optional. For ``text`` indexes, the name of the field, in
439439
the collection's documents, that contains the override language for
440440
the document. The default value is ``language``. See
441441
:ref:`specify-language-field-text-index-example` for an example.

‎source/reference/method/db.collection.createIndexes.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,9 @@ Definition
5252

5353

5454
MongoDB supports several different index types including
55-
:ref:`text <index-feature-text>`, :ref:`geospatial
56-
<index-feature-geospatial>`, and :ref:`hashed
57-
<index-type-hashed>` indexes. See :ref:`index types <index-types>`
58-
for more information.
55+
``text``, :ref:`geospatial <index-feature-geospatial>`, and
56+
:ref:`hashed <index-type-hashed>` indexes. See :ref:`index
57+
types <index-types>` for more information.
5958

6059
.. versionchanged:: 4.2
6160

@@ -299,7 +298,7 @@ otherwise specified:
299298
- :doc:`2dsphere </core/2dsphere>`
300299
- :doc:`2d </core/2d>`
301300
- :doc:`geoHaystack </core/geohaystack>`
302-
- :doc:`text </core/index-text>`
301+
- :ref:`text <index-feature-text>`
303302

304303
For a compound index that includes ``2dsphere`` index key(s)
305304
along with keys of other types, only the ``2dsphere`` index
@@ -408,7 +407,7 @@ Collation and Index Use
408407
Options for ``text`` Indexes
409408
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410409

411-
The following options are available for :doc:`text </core/index-text>`
410+
The following options are available for :ref:`text <index-feature-text>`
412411
indexes only:
413412

414413

@@ -426,7 +425,7 @@ indexes only:
426425

427426
- document
428427

429-
- Optional. For :doc:`text </core/index-text>` indexes, a document that contains
428+
- Optional. For ``text`` indexes, a document that contains
430429
field and weight pairs. The weight is an integer ranging from 1 to
431430
99,999 and denotes the significance of the field relative to the
432431
other indexed fields in terms of the score. You can specify weights
@@ -441,7 +440,7 @@ indexes only:
441440

442441
- string
443442

444-
- Optional. For :doc:`text </core/index-text>` indexes, the language that
443+
- Optional. For ``text`` indexes, the language that
445444
determines the list of stop words and the rules for the stemmer and
446445
tokenizer. See :ref:`text-search-languages` for the available
447446
languages and :doc:`/tutorial/specify-language-for-text-index` for
@@ -453,7 +452,7 @@ indexes only:
453452

454453
- string
455454

456-
- Optional. For :doc:`text </core/index-text>` indexes, the name of the field, in
455+
- Optional. For ``text`` indexes, the name of the field, in
457456
the collection's documents, that contains the override language for
458457
the document. The default value is ``language``. See
459458
:ref:`specify-language-field-text-index-example` for an example.

0 commit comments

Comments
 (0)