Skip to content

Minor: remove quotes from around :doc:, :ref: and :method: #1276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -185,15 +185,15 @@ following option:
kilobyte in size and may only contain characters in the base64 set and
the file must not have group or "world" permissions on UNIX systems.

.. seealso:: The ":ref:`Replica set Reconfiguration
<replica-set-reconfiguration-usage>`" section for information regarding
.. seealso:: The :ref:`Replica set Reconfiguration
<replica-set-reconfiguration-usage>` section for information regarding
the process for changing replica set during operation.

Additionally, consider the ":ref:`Replica Set Security
<replica-set-security>`" section for information on configuring
Additionally, consider the :ref:`Replica Set Security
<replica-set-security>` section for information on configuring
authentication with replica sets.

Finally, see the ":doc:`/replication`" document for more information
Finally, see the :doc:`/replication` document for more information
on replication in MongoDB and replica set configuration in general.

Sharding Configuration
Expand Down Expand Up @@ -223,7 +223,7 @@ configuration option:
This creates a config server running on the private IP address
``10.8.0.12`` on port ``27001``. Make sure that there are no port
conflicts, and that your config server is accessible from all of your
":program:`mongos`" and ":program:`mongod`" instances.
:program:`mongos` and :program:`mongod` instances.

To set up shards, configure two or more :program:`mongod` instance
using your :ref:`base configuration <base-config>`, adding the
Expand Down Expand Up @@ -252,7 +252,7 @@ avoid modifying the :setting:`chunkSize` from the default value of 64,
data, for which smaller chunk sizes are best, and minimizing chunk
migration, for which larger chunk sizes are optimal.

.. seealso:: The ":doc:`/sharding`" section of the manual for more
.. seealso:: The :doc:`/sharding` section of the manual for more
information on sharding and cluster configuration.

Run Multiple Database Instances on the Same System
Expand Down
4 changes: 2 additions & 2 deletions source/core/import-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ database backup operation, use full :doc:`database instance backups
:doc:`/reference/mongodb-extended-json` for more information about
MongoDB Extended JSON.

.. seealso:: See the ":doc:`/core/backups`" document for
.. seealso:: See the :doc:`/core/backups` document for
more information on backing up MongoDB instances. Additionally,
consider the following references for commands addressed in this
document:
Expand Down Expand Up @@ -135,7 +135,7 @@ Data Import and Export and Backups Operations

For resilient and non-disruptive backups,
use a file system or block-level disk snapshot function, such as the
methods described in the ":doc:`/core/backups`" document. The
methods described in the :doc:`/core/backups` document. The
tools and operations discussed provide functionality that's useful in
the context of providing some kinds of backups.

Expand Down
4 changes: 2 additions & 2 deletions source/core/read-preference-mechanics.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ will determine which member to target using the following process:
the read operation.

Drivers can then associate the thread or connection with the selected member.
This ":ref:`request association
<replica-set-read-preference-behavior-requests>`" is configurable by
This :ref:`request association
<replica-set-read-preference-behavior-requests>` is configurable by
the application. See your :doc:`driver </applications/drivers>`
documentation about request association configuration and default
behavior.
Expand Down
4 changes: 2 additions & 2 deletions source/faq/developers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ feature provides support for a large number of use-cases.
How do you aggregate data with MongoDB?
---------------------------------------

In version 2.1 and later, you can use the new ":doc:`aggregation
framework </core/aggregation>`," with the
In version 2.1 and later, you can use the new :doc:`aggregation
framework </core/aggregation>`, with the
:dbcommand:`aggregate` command.

MongoDB also supports :term:`map-reduce` with the
Expand Down
2 changes: 1 addition & 1 deletion source/faq/fundamentals.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ other ones. See the :ecosystem:`latest list of
drivers </drivers>`
for details.

.. seealso:: ":doc:`/applications/drivers`."
.. seealso:: :doc:`/applications/drivers`.

Does MongoDB support SQL?
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/command.txt
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Replication Commands

/reference/command/nav-replication

.. seealso:: ":doc:`/replication`" for more information regarding
.. seealso:: :doc:`/replication` for more information regarding
replication.

Sharding Commands
Expand Down
6 changes: 3 additions & 3 deletions source/reference/command/replSetInitiate.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ replSetInitiate

.. slave-ok, admin-only

.. seealso:: ":doc:`/reference/replica-configuration`,"
":doc:`/administration/replica-sets`," and ":ref:`Replica Set
Reconfiguration <replica-set-reconfiguration-usage>`."
.. seealso:: :doc:`/reference/replica-configuration`,
:doc:`/administration/replica-sets`, and :ref:`Replica Set
Reconfiguration <replica-set-reconfiguration-usage>`.
4 changes: 2 additions & 2 deletions source/reference/command/serverStatus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Definition
.. |operation-name| replace:: :dbcommand:`serverStatus`
.. include:: /includes/example-server-status-projection.rst

.. seealso:: :method:`db.serverStatus()` and ":doc:`/reference/server-status`"
.. seealso:: :method:`db.serverStatus()` and :doc:`/reference/server-status`

.. When adding status fields to this document, make sure that the
``docs/source/reference/server-status.txt`` document also
Expand Down Expand Up @@ -1055,7 +1055,7 @@ For an example of the ``Journaling (dur)`` output, see the
interval is configurable using the ``--journalCommitInterval``
option.

.. seealso:: ":doc:`/core/journaling`" for more information about journaling operations.
.. seealso:: :doc:`/core/journaling` for more information about journaling operations.

.. data:: serverStatus.dur.commits

Expand Down
10 changes: 5 additions & 5 deletions source/reference/configuration-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Settings
information. This option is only useful for the connection between
replica set members.

.. seealso:: ":ref:`Replica Set Security <replica-set-security>`"
.. seealso:: :ref:`Replica Set Security <replica-set-security>`

.. setting:: nounixsocket

Expand Down Expand Up @@ -698,9 +698,9 @@ Replication Options
sets. Specify a replica set name as an argument to this set. All
hosts must have the same set name.

.. seealso:: ":doc:`/replication`,"
":doc:`/administration/replica-set-deployment`," and
":doc:`/reference/replica-configuration`"
.. seealso:: :doc:`/replication`,
:doc:`/administration/replica-set-deployment`, and
:doc:`/reference/replica-configuration`

.. setting:: oplogSize

Expand Down Expand Up @@ -897,7 +897,7 @@ Sharded Cluster Options
:setting:`chunkSize` *only* sets the chunk size when initializing
the cluster for the first time. If you modify the run-time option
later, the new value will have no effect. See the
":ref:`sharding-balancing-modify-chunk-size`" procedure if you
:ref:`sharding-balancing-modify-chunk-size` procedure if you
need to change the chunk size on an existing sharded cluster.

.. setting:: localThreshold
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.collection.group.txt
Original file line number Diff line number Diff line change
Expand Up @@ -199,4 +199,4 @@ and the calculated aggregation field:

.. seealso:: :doc:`/core/aggregation`

.. STUB ":doc:`/applications/simple-aggregation`"
.. STUB :doc:`/applications/simple-aggregation`
2 changes: 1 addition & 1 deletion source/reference/method/db.listCommands.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ db.listCommands()
.. method:: db.listCommands()

Provides a list of all database commands. See the
":doc:`/reference/command`" document for a more extensive index of
:doc:`/reference/command` document for a more extensive index of
these options.
2 changes: 1 addition & 1 deletion source/reference/method/db.serverStatus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ db.serverStatus()
.. |operation-name| replace:: :method:`db.serverStatus()`
.. include:: /includes/example-server-status-projection.rst

.. seealso:: ":doc:`/reference/command/serverStatus`" for complete
.. seealso:: :doc:`/reference/command/serverStatus` for complete
documentation of the output of this function.
6 changes: 3 additions & 3 deletions source/reference/program/mongod.exe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ the Windows platform itself.

This document only references options that are unique to
:program:`mongod.exe`. All :program:`mongod` options are
available. See the ":doc:`/reference/program/mongod`" and the
":doc:`/reference/configuration-options`" documents for more
available. See the :doc:`/reference/program/mongod` and the
:doc:`/reference/configuration-options` documents for more
information regarding :program:`mongod.exe`.

To install and use :program:`mongod.exe`, read the
":doc:`/tutorial/install-mongodb-on-windows`" document.
:doc:`/tutorial/install-mongodb-on-windows` document.

Options
-------
Expand Down
14 changes: 7 additions & 7 deletions source/reference/program/mongod.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Core Options
runtime-configurations. While the options are equivalent and
accessible via the other command line arguments, the configuration
file is the preferred method for runtime configuration of
mongod. See the ":doc:`/reference/configuration-options`" document
mongod. See the :doc:`/reference/configuration-options` document
for more information about these options.

.. include:: /includes/note-configuration-file-must-be-ascii.rst
Expand Down Expand Up @@ -171,8 +171,8 @@ Core Options
information. This option is only useful for the connection between
replica set members.

.. seealso:: ":ref:`Replica Set Security <replica-set-security>`"
and ":doc:`/administration/replica-sets`."
.. seealso:: :ref:`Replica Set Security <replica-set-security>`
and :doc:`/administration/replica-sets`.

.. option:: --nounixsocket

Expand Down Expand Up @@ -533,9 +533,9 @@ Replication Options
a setname as an argument to this set. All hosts must have the same
set name.

.. seealso:: ":doc:`/replication`,"
":doc:`/administration/replica-sets`," and
":doc:`/reference/replica-configuration`"
.. seealso:: :doc:`/replication`,
:doc:`/administration/replica-sets`, and
:doc:`/reference/replica-configuration`

.. option:: --oplogSize <value>

Expand Down Expand Up @@ -688,5 +688,5 @@ following in the context of an initialization or control script:

mongod --config /etc/mongodb.conf

See the ":doc:`/reference/configuration-options`" for more information
See the :doc:`/reference/configuration-options` for more information
on how to configure :program:`mongod` using the configuration file.
2 changes: 1 addition & 1 deletion source/reference/program/mongodump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Usage

See the :doc:`/tutorial/backup-databases-with-binary-database-dumps`
for a larger overview of :program:`mongodump` usage. Also see the
":doc:`mongorestore`" document for an overview of the
:doc:`mongorestore` document for an overview of the
:program:`mongorestore`, which provides the related inverse
functionality.

Expand Down
6 changes: 3 additions & 3 deletions source/reference/program/mongoexport.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Synopsis

:program:`mongoexport` is a utility that produces a JSON or CSV export
of data stored in a MongoDB instance. See the
":doc:`/core/import-export`" document for a more in depth
usage overview, and the ":doc:`mongoimport`" document for more
:doc:`/core/import-export` document for a more in depth
usage overview, and the :doc:`mongoimport` document for more
information regarding the :program:`mongoimport` utility, which
provides the inverse "importing" capability.

Expand All @@ -22,7 +22,7 @@ provides the inverse "importing" capability.
Do not use :program:`mongoimport` and :program:`mongoexport` for
full-scale backups because they may not reliably capture data type
information. Use :program:`mongodump` and :program:`mongorestore` as
described in ":doc:`/core/backups`" for this kind of
described in :doc:`/core/backups` for this kind of
functionality.

Options
Expand Down
6 changes: 3 additions & 3 deletions source/reference/program/mongoimport.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Synopsis
The :program:`mongoimport` tool provides a route to import content from a
JSON, CSV, or TSV export created by :program:`mongoexport`, or
potentially, another third-party export tool. See the
":doc:`/core/import-export`" document for a more in depth
usage overview, and the ":doc:`mongoexport`" document for more
:doc:`/core/import-export` document for a more in depth
usage overview, and the :doc:`mongoexport` document for more
information regarding :program:`mongoexport`, which
provides the inverse "importing" capability.

Expand All @@ -23,7 +23,7 @@ provides the inverse "importing" capability.
Do not use :program:`mongoimport` and :program:`mongoexport` for
full instance, production backups because they will not reliably capture data type
information. Use :program:`mongodump` and :program:`mongorestore` as
described in ":doc:`/core/backups`" for this kind of
described in :doc:`/core/backups` for this kind of
functionality.

Options
Expand Down
2 changes: 1 addition & 1 deletion source/reference/program/mongooplog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ your operation.
:program:`mongooplog` will not be able to copy oplog entries.

.. seealso:: :program:`mongodump`, :program:`mongorestore`,
":doc:`/core/backups`", ":doc:`/core/replica-set-oplog`.
:doc:`/core/backups`, :doc:`/core/replica-set-oplog`.

Options
-------
Expand Down
2 changes: 1 addition & 1 deletion source/reference/program/mongorestore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Usage

See :doc:`/tutorial/backup-databases-with-binary-database-dumps`
for a larger overview of :program:`mongorestore`
usage. Also see the ":doc:`mongodump`" document for an overview of the
usage. Also see the :doc:`mongodump` document for an overview of the
:program:`mongodump`, which provides the related inverse
functionality.

Expand Down
6 changes: 3 additions & 3 deletions source/reference/program/mongos.exe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ the Windows platform itself.

This document only references options that are unique to
:program:`mongos.exe`. All :program:`mongos` options are
available. See the ":doc:`/reference/program/mongos`" and the
":doc:`/reference/configuration-options`" documents for more
available. See the :doc:`/reference/program/mongos` and the
:doc:`/reference/configuration-options` documents for more
information regarding :program:`mongos.exe`.

To install and use :program:`mongos.exe`, read the
":doc:`/tutorial/install-mongodb-on-windows`" document.
:doc:`/tutorial/install-mongodb-on-windows` document.

Options
-------
Expand Down
4 changes: 2 additions & 2 deletions source/reference/program/mongos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
runtime-configurations. While the options are equivalent and
accessible via the other command line arguments, the configuration
file is the preferred method for runtime configuration of
mongod. See the ":doc:`/reference/configuration-options`" document
mongod. See the :doc:`/reference/configuration-options` document
for more information about these options.

Not all configuration options for :program:`mongod` make sense in
Expand Down Expand Up @@ -239,7 +239,7 @@ Options
This option *only* sets the chunk size when initializing the
cluster for the first time. If you modify the run-time option
later, the new value will have no effect. See the
":ref:`sharding-balancing-modify-chunk-size`" procedure if you
:ref:`sharding-balancing-modify-chunk-size` procedure if you
need to change the chunk size on an existing sharded cluster.

.. option:: --ipv6
Expand Down
2 changes: 1 addition & 1 deletion source/reference/program/mongostat.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ UNIX/Linux file system utility ``vmstat``, but provides data regarding
- :doc:`/reference/command/collStats`

For an additional utility that provides MongoDB metrics see
":doc:`mongotop </reference/program/mongotop>`."
:doc:`mongotop </reference/program/mongotop>`.

:program:`mongostat` connects to the :program:`mongod` instance running
on the local host interface on TCP port ``27017``; however,
Expand Down
2 changes: 1 addition & 1 deletion source/reference/program/mongotop.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ provides statistics on a per-collection level. By default,
- :doc:`/reference/command/collStats`

For an additional utility that provides MongoDB metrics
see ":doc:`mongostat </reference/program/mongostat>`."
see :doc:`mongostat </reference/program/mongostat>`.

.. _mongotop-options:

Expand Down
6 changes: 3 additions & 3 deletions source/reference/replica-configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Configuration Variables
prevents read operations (i.e. queries) from ever reaching this
host by way of secondary :term:`read preference`.

.. seealso:: ":ref:`Hidden Replica Set Members <replica-set-hidden-members>`"
.. seealso:: :ref:`Hidden Replica Set Members <replica-set-hidden-members>`

.. data:: local.system.replset.members[n].priority

Expand All @@ -190,8 +190,8 @@ Configuration Variables
A :data:`~local.system.replset.members[n].priority` of ``0`` makes it impossible for a
member to become primary.

.. seealso:: ":data:`~local.system.replset.members[n].priority`" and
":ref:`Replica Set Elections <replica-set-elections>`."
.. seealso:: :data:`~local.system.replset.members[n].priority` and
:ref:`Replica Set Elections <replica-set-elections>`.

.. data:: local.system.replset.members[n].tags

Expand Down
Loading