DOCSP-21629 Consistent Syntax Examples: R (#1490)

Author: jmd-mongo

source/reference/command/reIndex.txt

@@ -31,25 +31,35 @@ Definition
         instances. 
       - For most users, the :dbcommand:`reIndex` command is unnecessary.
 
-   Use the following syntax:
-
-   .. code-block:: javascript
-
-      { reIndex: <collection> }
-
-   The command takes the following fields:
-
-   .. list-table::
-      :header-rows: 1
-      :widths: 20 80
-
-      * - Field
-        - Description
-
-      * - reIndex
-        - The name of the collection to reindex.
-
-   :binary:`~bin.mongosh` provides a wrapper :method:`db.collection.reIndex()`.
+Syntax
+------
+
+The command has the following syntax:
+
+.. code-block:: javascript
+
+   db.runCommand(
+      { 
+        reIndex: <collection> 
+      }
+   )
+
+Command Fields
+--------------
+
+The command takes the following fields:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 80
+ 
+   * - Field
+     - Description
+ 
+   * - reIndex
+     - The name of the collection to reindex.
+ 
+:binary:`~bin.mongosh` provides a wrapper :method:`db.collection.reIndex()`.
 
 Behavior
 --------

source/reference/command/refineCollectionShardKey.txt

@@ -46,45 +46,39 @@ Syntax
    cluster must have :ref:`feature compatibility version (fcv) <view-fcv>`
    of ``4.4``.
 
-The :dbcommand:`refineCollectionShardKey` command must be run against
-the ``admin`` database and has the following form:
+The command has the following syntax:
 
 .. code-block:: javascript
 
-   db.adminCommand( { 
-      refineCollectionShardKey: "<database>.<collection>", 
-      key: { <existing key specification>, <suffix1>: <1|"hashed">, ... }
-   } )
+   db.adminCommand( 
+      { 
+        refineCollectionShardKey: "<database>.<collection>", 
+        key: { <existing key specification>, <suffix1>: <1|"hashed">, ... }
+      } 
+   )
 
 Command Fields
-~~~~~~~~~~~~~~
-
-The :dbcommand:`refineCollectionShardKey` command has the following fields:
+--------------
 
+The command takes the following fields:
 
 .. list-table::
    :header-rows: 1
    :widths: 20 20 80
 
    * - Field
-
      - Type
-
      - Description
 
    * - :ref:`refineCollectionShardKey <refineCollectionShardKey-namespace>`
-
      - string
-
      - .. _refineCollectionShardKey-namespace:
 
        The :term:`namespace` of the sharded collection in the
        form ``"<database>.<collection>"``.
 
    * - :ref:`key <refineCollectionShardKey-key>`
-
      - document
-
      - .. _refineCollectionShardKey-key:
 
        The document that specifies the field or fields to use as the

source/reference/command/refreshSessions.txt

@@ -19,20 +19,34 @@ Definition
    for the specified sessions, thereby extending the active state of
    the sessions.
 
-   :dbcommand:`refreshSessions` has the following syntax:
+Syntax
+------
 
-   .. code-block:: javascript
+The command has the following syntax:
 
-      { refreshSessions: [ { id : <UUID> }, ... ] } )
+.. code-block:: javascript
 
-   .. include:: /includes/fact-dbcommand.rst
+   db.runCommand(
+      { 
+        refreshSessions: [ 
+          { id : <UUID> }, ... 
+        ] 
+      } 
+    )
 
-   .. |command| replace:: :dbcommand:`refreshSessions`
+.. include:: /includes/fact-dbcommand.rst
 
-   .. code-block:: javascript
+.. |command| replace:: :dbcommand:`refreshSessions`
 
-      db.runCommand( { refreshSessions: [ { id : <UUID> }, ... ] } )
+.. code-block:: javascript
 
+   db.runCommand( 
+      { 
+        refreshSessions: [ 
+          { id : <UUID> }, ... 
+        ] 
+      } 
+   )
 
 Behavior
 --------

source/reference/command/removeShard.txt

@@ -10,6 +10,9 @@ removeShard
    :depth: 1
    :class: singlecol
 
+Definition
+----------
+
 .. dbcommand:: removeShard
 
    Removes a shard from a :term:`sharded cluster`. When you run
@@ -18,14 +21,17 @@ removeShard
    drained, MongoDB removes the shard from the cluster.
 
 Syntax
--------
+------
 
-To run, from a :binary:`~bin.mongos` instance, issue the command
-against the ``admin`` database:
+The command has the following syntax:
 
 .. code-block:: javascript
 
-   db.adminCommand( { removeShard : <shardToRemove> } )
+   db.adminCommand( 
+      { 
+        removeShard : <shardToRemove> 
+      } 
+   )
 
 Behavior
 --------

source/reference/command/removeShardFromZone.txt

@@ -26,7 +26,7 @@ Syntax
 You can only run :dbcommand:`removeShardFromZone` on the ``admin`` database
 from a :binary:`~bin.mongos` instance.
 
-The :dbcommand:`removeShardFromZone` command has the following syntax:
+The command has the following syntax:
 
 .. code-block:: javascript
 
@@ -37,41 +37,33 @@ The :dbcommand:`removeShardFromZone` command has the following syntax:
       }
    )
 
-The command takes the following fields:
+Command Fields
+--------------
 
+The command takes the following fields:
 
 .. list-table::
    :header-rows: 1
    :widths: 20 20 80
 
    * - Field
-
      - Type
-
      - Description
 
    * - :ref:`removeShardFromZone <cmd-removeShardFromZone-shard>`
-
      - string
-
      - .. _cmd-removeShardFromZone-shard:
 
        The name of the shard from which to remove the :ref:`zone
        <cmd-removeShardFromZone-zone>` association.
 
-       
-
    * - :ref:`zone <cmd-removeShardFromZone-zone>`
-
      - string
-
      - .. _cmd-removeShardFromZone-zone:
 
        The name of the zone whose association with the :ref:`shard
        <cmd-removeShardFromZone-shard>` you want to remove.
 
-       
-   
 :binary:`~bin.mongosh` provides the helper method
 :method:`sh.removeShardFromZone()`.
 

source/reference/command/renameCollection.txt

@@ -22,75 +22,68 @@ Definition
    Issue the :dbcommand:`renameCollection` command against the
    :term:`admin database`.
 
-   The command takes the following form:
+Syntax
+------
 
-   .. code-block:: javascript
+The command has the following syntax:
 
-      { renameCollection: "<source_namespace>",
+.. code-block:: javascript
+
+   db.runCommand(
+      { 
+        renameCollection: "<source_namespace>",
         to: "<target_namespace>",
         dropTarget: <true|false>,
         writeConcern: <document>,
-        comment: <any> }
-
-   The command contains the following fields:
-
-
-   .. list-table::
-      :header-rows: 1
-      :widths: 20 20 80
-   
-      * - Field
-   
-        - Type
-   
-        - Description
-   
-      * - ``renameCollection``
-   
-        - string
-   
-        - The :term:`namespace` of the collection to rename. The namespace is a
-          combination of the database name and the name of the collection.
-   
-      * - ``to``
-   
-        - string
-   
-        - The new namespace of the collection. If the new namespace specifies a
-          different database, the :dbcommand:`renameCollection` command copies
-          the collection to the new database and drops the source collection.
-          See :ref:`restrictions-on-db-names`.
-   
-      * - ``dropTarget``
-   
-        - boolean
-   
-        - Optional. If ``true``, :binary:`~bin.mongod` will drop the ``target`` of
-          :dbcommand:`renameCollection` prior to renaming the collection. The
-          default value is ``false``.
-          
-          
-   
-      * - ``writeConcern``
-   
-        - document
-   
-        - Optional. A document that expresses the :doc:`write concern </reference/write-concern>`
-          for the operation. Omit to use the default write
-          concern.
-          
-          .. include:: /includes/extracts/mongos-operations-wc-rename-collection.rst
-          
-      * - ``comment``
-
-        - any
-
-        - .. include:: /includes/extracts/comment-content.rst
+        comment: <any> 
+      }
+   )
+
+Command Fields
+--------------
+
+The command contains the following fields:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 20 80
+ 
+   * - Field
+     - Type
+     - Description
+ 
+   * - ``renameCollection``
+     - string
+     - The :term:`namespace` of the collection to rename. The namespace is a
+       combination of the database name and the name of the collection.
+ 
+   * - ``to``
+     - string
+     - The new namespace of the collection. If the new namespace specifies a
+       different database, the :dbcommand:`renameCollection` command copies
+       the collection to the new database and drops the source collection.
+       See :ref:`restrictions-on-db-names`.
+ 
+   * - ``dropTarget``
+     - boolean
+     - Optional. If ``true``, :binary:`~bin.mongod` will drop the ``target`` of
+       :dbcommand:`renameCollection` prior to renaming the collection. The
+       default value is ``false``.
+ 
+   * - ``writeConcern``
+     - document
+     - Optional. A document that expresses the :doc:`write concern </reference/write-concern>`
+       for the operation. Omit to use the default write
+       concern.
 
-          .. versionadded:: 4.4          
-   
-
-
+       .. include:: /includes/extracts/mongos-operations-wc-rename-collection.rst
+       
+   * - ``comment``
+     - any
+     - .. include:: /includes/extracts/comment-content.rst
+    
+       .. versionadded:: 4.4          
+ 
 Behavior
 --------
 

source/reference/command/replSetAbortPrimaryCatchUp.txt

@@ -17,9 +17,17 @@ Definition
 
    The ``replSetAbortPrimaryCatchUp`` command forces the elected
    :term:`primary` member of the replica set to abort sync (catch up)
-   then complete the transition to primary. The command has the
-   following prototype form:
+   then complete the transition to primary. 
 
-   .. code-block:: javascript
+Syntax
+------
 
-      { replSetAbortPrimaryCatchUp: 1 }
+The command has the following syntax:
+
+.. code-block:: javascript
+   
+   db.runCommand(
+      { 
+        replSetAbortPrimaryCatchUp: 1 
+      }
+   )