DOCS-1016 final update/copy edits to undocumented sharding methods

Ed Costello · Ed Costello · commit 737d706ad463 · 2013-02-22T18:07:58.000-05:00
diff --git a/source/reference/method/sh._adminCommand.txt b/source/reference/method/sh._adminCommand.txt
@@ -6,15 +6,13 @@ sh._adminCommand()
 
 .. method:: sh._adminCommand(cmd, checkMongos)
 
-   :param string dbcommand: a database command to run against the ``admin``
+   :param string dbcommand: A database command to run against the ``admin``
                             database.
 
-   :param Boolean checkMongos: verify whether or not the shell is connected 
+   :param Boolean checkMongos: Verify whether or not the shell is connected 
                                to a :program:`mongos` instance.
                                
    The :method:`sh._adminCommand` method runs a database command against
    the admin database of a :program:`mongos` instance.
     
-.. seealso::
-
-   - :method:`db.runCommand`
+.. seealso:: :method:`db.runCommand()`
diff --git a/source/reference/method/sh._checkFullName.txt b/source/reference/method/sh._checkFullName.txt
@@ -6,11 +6,11 @@ sh._checkFullName()
 
 .. method:: sh._checkFullName(namespace)
 
-   :param string namespace: specify a complete namespace.
+   :param string namespace: Specify a complete namespace.
    
    :throws: "name needs to be fully qualified <db>.<collection>"
    
    The :method:`sh._checkFullName()` method verifies that a namespace
    name is well-formed.  If the name has a period ``.`` then the 
    :method:`sh._checkFullName()` method exits, otherwise it throws
-   an error.
+   an error.
diff --git a/source/reference/method/sh._lastMigration.txt b/source/reference/method/sh._lastMigration.txt
@@ -9,26 +9,28 @@ sh._lastMigration()
    :param string namespace: The name of a database or collection within the
                             current database. 
 
-   :returns: a document with fields detailing the most recent migration
+   :returns: A document with fields detailing the most recent migration
              in the specified namespace.
 
    :method:`sh._lastMigration()` returns a document with details about
    the last migration performed on the database or collection you specify.
+
+   Document details:
    
-   :field string _id: the id of the migration task
+   :field string _id: The id of the migration task
 
-   :field string server: the name of the server 
+   :field string server: The name of the server 
 
-   :field string clientAddr: the IP address and port number of the server.
+   :field string clientAddr: The IP address and port number of the server.
 
-   :field ISODate time: the time of the last migration.
+   :field ISODate time: The time of the last migration.
 
-   :field string what: the specific type of migration.
+   :field string what: The specific type of migration.
 
-   :field string ns: the complete namespace of the collection affected
+   :field string ns: The complete namespace of the collection affected
                      by the migration.
 
-   :field document details: a document containing details about the 
+   :field document details: A document containing details about the 
                             migrated chunk. Includes ``min`` and ``max``
                             sub-documents with the bounds of the migrated
                             chunk.
diff --git a/source/reference/method/sh.disableBalancing.txt b/source/reference/method/sh.disableBalancing.txt
@@ -6,7 +6,7 @@ sh.disableBalancing()
 
 .. method:: sh.disableBalancing(collection)
 
-   :param string collection: the name of a collection.
+   :param string collection: The name of a collection.
 
    :method:`sh.disableBalancing()` disables the balancer for the specified 
    sharded collection.
diff --git a/source/reference/method/sh.enableBalancing.txt b/source/reference/method/sh.enableBalancing.txt
@@ -6,7 +6,7 @@ sh.enableBalancing()
 
 .. method:: sh.enableBalancing(collection)
 
-   :param string collection: the name of a collection.
+   :param string collection: The name of a collection.
 
    :method:`sh.enableBalancing()` enables the balancer for the specified 
    sharded collection.
diff --git a/source/reference/method/sh.enableSharding.txt b/source/reference/method/sh.enableSharding.txt
@@ -12,7 +12,5 @@ sh.enableSharding()
    automatically shard any collections, but makes it possible to begin
    sharding collections using :method:`sh.shardCollection()`.
 
-.. seealso::
-    
-   - :ref:`sh.shardCollection()`
-   
+.. seealso:: :method:`sh.shardCollection()`
+   
diff --git a/source/reference/method/sh.getBalancerHost.txt b/source/reference/method/sh.getBalancerHost.txt
@@ -6,7 +6,7 @@ sh.getBalancerHost()
 
 .. method:: sh.getBalancerHost()
 
-   :returns: string in form :samp:`{hostname}:{port}`
+   :returns: String in form :samp:`{hostname}:{port}`
    
    :method:`sh.getBalancerHost()` returns the name of the server that is
    running the balancer.
diff --git a/source/reference/method/sh.getBalancerState.txt b/source/reference/method/sh.getBalancerState.txt
@@ -6,7 +6,7 @@ sh.getBalancerState()
 
 .. method:: sh.getBalancerState()
 
-   :returns: Boolean
+   :returns: boolean
 
    :method:`sh.getBalancerState()` returns ``true`` when the
    :term:`balancer` is enabled and false if the balancer is
diff --git a/source/reference/method/sh.isBalancerRunning.txt b/source/reference/method/sh.isBalancerRunning.txt
@@ -6,7 +6,7 @@ sh.isBalancerRunning()
 
 .. method:: sh.isBalancerRunning()
 
-   :returns: Boolean
+   :returns: boolean
 
    Returns true if the :term:`balancer` process is currently running
    and migrating chunks and false if the balancer process is not
diff --git a/source/reference/method/sh.setBalancerState.txt b/source/reference/method/sh.setBalancerState.txt
@@ -6,7 +6,7 @@ sh.setBalancerState()
 
 .. method:: sh.setBalancerState(state)
 
-   :param Boolean state: ``true`` enables the balancer if disabled,
+   :param boolean state: ``true`` enables the balancer if disabled,
                          and ``false`` disables the balancer.
 
    Enables or disables the :term:`balancer`. Use
diff --git a/source/reference/method/sh.startBalancer.txt b/source/reference/method/sh.startBalancer.txt
@@ -6,9 +6,9 @@ sh.startBalancer()
 
 .. method:: sh.startBalancer(timeout, interval)
    
-   :param integer timeout: milliseconds to wait.
+   :param integer timeout: Milliseconds to wait.
    
-   :param integer interval: milliseconds to sleep each cycle of waiting.
+   :param integer interval: Milliseconds to sleep each cycle of waiting.
    
    The :method:`sh.startBalancer()` enables the balancer in a sharded
    cluster and waits for balancing to initiate.
diff --git a/source/reference/method/sh.stopBalancer.txt b/source/reference/method/sh.stopBalancer.txt
@@ -6,9 +6,9 @@ sh.stopBalancer()
 
 .. method:: sh.stopBalancer(timeout, interval)
    
-   :param integer timeout: milliseconds to wait.
+   :param integer timeout: Milliseconds to wait.
    
-   :param integer interval: milliseconds to sleep each cycle of waiting.
+   :param integer interval: Milliseconds to sleep each cycle of waiting.
    
    The :method:`sh.stopBalancer()` disables the balancer in a sharded
    cluster and waits for balancing to complete.
diff --git a/source/reference/method/sh.waitForBalancer.txt b/source/reference/method/sh.waitForBalancer.txt
@@ -6,12 +6,12 @@ sh.waitForBalancer()
 
 .. method:: sh.waitForBalancer(onOrNot, timeout, interval)
 
-   :param Boolean onOrNot: whether to wait for the lock to be
+   :param Boolean onOrNot: Whether to wait for the lock to be
                            on (``true``) or off (``false``).
    
-   :param integer timeout: milliseconds to wait.
+   :param integer timeout: Milliseconds to wait.
                 
-   :param integer interval: milliseconds to sleep.
+   :param integer interval: Milliseconds to sleep.
 
 
    :method:`sh.waitForBalancer()` is an internal method that waits for
diff --git a/source/reference/method/sh.waitForBalancerOff.txt b/source/reference/method/sh.waitForBalancerOff.txt
@@ -6,9 +6,9 @@ sh.waitForBalancerOff()
 
 .. method:: sh.waitForBalancerOff()
 
-   :param integer timeout: milliseconds to wait.
+   :param integer timeout: Milliseconds to wait.
                 
-   :param integer interval: milliseconds to sleep.
+   :param integer interval: Milliseconds to sleep.
 
    :method:`sh.waitForBalancerOff()` is an internal method that waits
    until the balancer is not running.
diff --git a/source/reference/method/sh.waitForDLock.txt b/source/reference/method/sh.waitForDLock.txt
@@ -6,14 +6,14 @@ sh.waitForDLock()
 
 .. method:: sh.waitForDLock(lockId, onOrNot, timeout, interval)
 
-   :param string lockId: the name of the lock.
+   :param string lockId: The name of the lock.
    
-   :param Boolean onOrNot: optional, whether to wait for the lock to be
+   :param Boolean onOrNot: Optional, whether to wait for the lock to be
                            on (``true``) or off (``false``).
                            
-   :param integer timeout: milliseconds to wait.
+   :param integer timeout: Milliseconds to wait.
                 
-   :param integer interval: milliseconds to sleep in each waiting cycle.
+   :param integer interval: Milliseconds to sleep in each waiting cycle.
 
    :method:`sh.waitForDLock()` is an internal method that waits until
    the specified lock is changes state. 
diff --git a/source/reference/method/sh.waitForPingChange.txt b/source/reference/method/sh.waitForPingChange.txt
@@ -6,9 +6,12 @@ sh.waitForPingChange()
 
 .. method:: sh.waitForPingChange(activepings, timeout, interval)
 
-   :param array activepings: an array of active pings from the 
+   :param array activepings: An array of active pings from the 
                              ``config.mongos`` collection.
                              
-   :param integer timeout: milliseconds to wait for a change in ping state.
+   :param integer timeout: Milliseconds to wait for a change in ping state.
                 
-   :param integer interval: milliseconds to sleep in each waiting cycle.
+   :param integer interval: Milliseconds to sleep in each waiting cycle.
+
+   :method:`sh.waitForPingChange()` waits for a change in ping state
+   of the one of the ``activepings``.
