definitions for method reference lists

source/includes/ref-toc-method-connection.yaml

@@ -1,28 +1,28 @@
 name: ":method:`source/reference/method/Mongo.getDB()`"
 file: /reference/method/Mongo.getDB
-description:
+description: "Provides access to a database."
 ---
 name: ":method:`source/reference/method/Mongo.getReadPrefMode()`"
 file: /reference/method/Mongo.getReadPrefMode
-description:
+description: "Displays the current read preference mode for the MongoDB connection."
 ---
 name: ":method:`source/reference/method/Mongo.getReadPrefTagSet()`"
 file: /reference/method/Mongo.getReadPrefTagSet
-description:
+description: "Displays the read preference tag set for the MongoDB connection."
 ---
 name: ":method:`source/reference/method/Mongo.setReadPref()`"
 file: /reference/method/Mongo.setReadPref
-description:
+description: "Sets the read preference for the MongoDB connection."
 ---
 name: ":method:`source/reference/method/Mongo.setSlaveOk()`"
 file: /reference/method/Mongo.setSlaveOk
-description:
+description: "Allows applications to read from secondary members, which means eventual consistency is acceptable in read operations."
 ---
 name: ":method:`source/reference/method/Mongo()`"
 file: /reference/method/Mongo
-description:
+description: "Creates a new connection object."
 ---
 name: ":method:`source/reference/method/connect()`"
 file: /reference/method/connect
-description:
+description: "Creates a new connection object and accesses a specified database."
 ...

source/includes/ref-toc-method-constructor.yaml

@@ -1,20 +1,20 @@
 name: ":method:`source/reference/method/Date()`"
 file: /reference/method/Date
-description:
+description: "Returns the current date."
 ---
 name: ":method:`source/reference/method/UUID()`"
 file: /reference/method/UUID
-description:
+description: "Converts a 32-byte hexadecimal string to the UUID BSON subtype."
 ---
 name: ":method:`source/reference/method/ObjectId.getTimestamp()`"
 file: /reference/method/ObjectId.getTimestamp
-description:
+description: "Returns the timestamp portion of an ObjectId."
 ---
 name: ":method:`source/reference/method/ObjectId.toString()`"
 file: /reference/method/ObjectId.toString
-description:
+description: "Displays the string representation of an ObjectId."
 ---
 name: ":method:`source/reference/method/ObjectId.valueOf()`"
 file: /reference/method/ObjectId.valueOf
-description:
-...
+description: "Displays the ``str`` attribute of an ObjectId as a lowercase hexadecimal string.
+...

source/includes/ref-toc-method-database.yaml

@@ -1,176 +1,176 @@
 name: ":method:`db.addUser()`"
 file: /reference/method/db.addUser
-description:
+description: "Adds a user to a database and sets the user's access levels."
 ---
 name: ":method:`db.auth()`"
 file: /reference/method/db.auth
-description:
+description: "Authenticates a user to a database."
 ---
 name: ":method:`db.cloneCollection()`"
 file: /reference/method/db.cloneCollection
-description:
+description: "Provides a wrapper around :dbcommand:`cloneCollection` for copying data directly between MongoDB instances."
 ---
 name: ":method:`db.cloneDatabase()`"
 file: /reference/method/db.cloneDatabase
-description:
+description: "Provides a wrapper around :dbcommand:`clone` and copies a database from a remote host to the current host."
 ---
 name: ":method:`db.commandHelp()`"
 file: /reference/method/db.commandHelp
-description:
+description: "Returns help information for the specified :term:`database command`.
 ---
 name: ":method:`db.copyDatabase()`"
 file: /reference/method/db.copyDatabase
-description:
+description: "Provides a wrapper around :dbcommand:`copydb` and creates a copy of a database within another database."
 ---
 name: ":method:`db.createCollection()`"
 file: /reference/method/db.createCollection
-description:
+description: "Creates a new collection and provides the option to create a capped collection."
 ---
 name: ":method:`db.currentOp()`"
 file: /reference/method/db.currentOp
-description:
+description: "Reports the current operation in progress."
 ---
 name: ":method:`db.dropDatabase()`"
 file: /reference/method/db.dropDatabase
-description:
+description: "Removes the current database."
 ---
 name: ":method:`db.eval()`"
 file: /reference/method/db.eval
-description:
+description: "Runs the JavaScript function and arguments enclosed in the parentheses."
 ---
 name: ":method:`db.fsyncLock()`"
 file: /reference/method/db.fsyncLock
-description:
+description: "Provides a wrapper around :dbcommand:`fsync`. Flushes writes to disk and locks the database to create a window for backups"
 ---
 name: ":method:`db.fsyncUnlock()`"
 file: /reference/method/db.fsyncUnlock
-description:
+description: "Unlocks a database and allows writes, typically after a backup."
 ---
 name: ":method:`db.getCollection()`"
 file: /reference/method/db.getCollection
-description:
+description: "Provides access to a collection that uses a name that has syntax that interacts with the shell."
 ---
 name: ":method:`db.getCollectionNames()`"
 file: /reference/method/db.getCollectionNames
-description:
+description: "Lists all collections in the current database."
 ---
 name: ":method:`db.getLastError()`"
 file: /reference/method/db.getLastError
-description:
+description: "Returns the success status of the last operation."
 ---
 name: ":method:`db.getLastErrorObj()`"
 file: /reference/method/db.getLastErrorObj
-description:
+description: "Returns the document containing all status information about the last operation."
 ---
 name: ":method:`db.getMongo()`"
 file: /reference/method/db.getMongo
-description:
+description: "Displays the IP address and port number of the MongoDB connection"
 ---
 name: ":method:`db.getName()`"
 file: /reference/method/db.getName
-description:
+description: "Displays the name of the current database."
 ---
 name: ":method:`db.getPrevError()`"
 file: /reference/method/db.getPrevError
-description:
+description: "Returns status document containing all errors since the last error reset."
 ---
 name: ":method:`db.getProfilingLevel()`"
 file: /reference/method/db.getProfilingLevel
-description:
+description: "Returns a number that indicates the level of profiling for database operations."
 ---
 name: ":method:`db.getProfilingStatus()`"
 file: /reference/method/db.getProfilingStatus
-description:
+description: "Returns a document that indicates the level of profiling and the profiling threshold for database operations."
 ---
 name: ":method:`db.getReplicationInfo()`"
 file: /reference/method/db.getReplicationInfo
-description:
+description: "Returns a document with replication statistics."
 ---
 name: ":method:`db.getSiblingDB()`"
 file: /reference/method/db.getSiblingDB
-description:
+description: "Provides access to the specified database."
 ---
 name: ":method:`db.help()`"
 file: /reference/method/db.help
-description:
+description: "Displays descriptions of common ``db`` object methods."
 ---
 name: ":method:`db.hostInfo()`"
 file: /reference/method/db.hostInfo
-description:
+description: "Provides a wrapper to :dbcommand:`hostInfo` and returns a document with information about the system MongoDB runs on."
 ---
 name: ":method:`db.isMaster()`"
 file: /reference/method/db.isMaster
-description:
+description: "Returns a document that reports this :program:`mongod` instance's role in the replica set, including whether it is the master."
 ---
 name: ":method:`db.killOp()`"
 file: /reference/method/db.killOp
-description:
+description: "Terminates the specified operation."
 ---
 name: ":method:`db.listCommands()`"
 file: /reference/method/db.listCommands
-description:
+description: "Displays a list of common database commands."
 ---
 name: ":method:`db.loadServerScripts()`"
 file: /reference/method/db.loadServerScripts
-description:
+description: "Loads all scripts in the ``system.js`` collection for the current database into the shell session."
 ---
 name: ":method:`db.logout()`"
 file: /reference/method/db.logout
-description:
+description: "Ends an authenticated session."
 ---
 name: ":method:`db.printCollectionStats()`"
 file: /reference/method/db.printCollectionStats
-description:
+description: "Provides a wrapper around :method:`db.collection.stats()` and returns statistics from every collection."
 ---
 name: ":method:`db.printReplicationInfo()`"
 file: /reference/method/db.printReplicationInfo
-description:
+description: "Provides a formatted report of the status of the replica set from the perspective of the primary."
 ---
 name: ":method:`db.printShardingStatus()`"
 file: /reference/method/db.printShardingStatus
-description:
+description: "Provides a formatted report of the sharding configuration and the existing chunks."
 ---
 name: ":method:`db.printSlaveReplicationInfo()`"
 file: /reference/method/db.printSlaveReplicationInfo
-description:
+description: "Provides a formatted report of the status of the replica set from the perspective of the secondary."
 ---
 name: ":method:`db.removeUser()`"
 file: /reference/method/db.removeUser
-description:
+description: "Removes a user from a database."
 ---
 name: ":method:`db.repairDatabase()`"
 file: /reference/method/db.repairDatabase
-description:
+description: "Runs a repair routine on the current database."
 ---
 name: ":method:`db.resetError()`"
 file: /reference/method/db.resetError
-description:
+description: "Resets the error message returned by :method:`db.getPrevError()` and :dbcommand:`getPrevError`."
 ---
 name: ":method:`db.runCommand()`"
 file: /reference/method/db.runCommand
-description:
+description: "Runs a specified :doc:`database command </reference/commands>`."
 ---
 name: ":method:`db.serverBuildInfo()`"
 file: /reference/method/db.serverBuildInfo
-description:
+description: "Returns a document that displays the parameters used to compile this :program:`mongod` instance."
 ---
 name: ":method:`db.serverStatus()`"
 file: /reference/method/db.serverStatus
-description:
+description: "Returns a document that provides an overview of the state of the database process."
 ---
 name: ":method:`db.setProfilingLevel()`"
 file: /reference/method/db.setProfilingLevel
-description:
+description: "Modifies the current level of database profiling."
 ---
 name: ":method:`db.shutdownServer()`"
 file: /reference/method/db.shutdownServer
-description:
+description: "Shuts down the current :program:`mongod` or :program:`mongos` process cleanly and safely."
 ---
 name: ":method:`db.stats()`"
 file: /reference/method/db.stats
-description:
+description: "Returns a document that displays database statistics."
 ---
 name: ":method:`db.version()`"
 file: /reference/method/db.version
-description:
+description: "Displays the version of MongoDB."
 ...

source/includes/ref-toc-method-other.yaml

@@ -1,76 +1,76 @@
 name: ":method:`source/reference/method/cat()`"
 file: /reference/method/cat
-description:
+description: "Returns the contents of the specified file."
 ---
 name: ":method:`source/reference/method/cd()`"
 file: /reference/method/cd
-description:
+description: "Changes the current working directory to the specified path."
 ---
 name: ":method:`source/reference/method/copyDbpath()`"
 file: /reference/method/copyDbpath
-description:
+description: "For internal use."
 ---
 name: ":method:`source/reference/method/fuzzFile()`"
 file: /reference/method/fuzzFile
-description:
+description: "For internal use."
 ---
 name: ":method:`source/reference/method/getHostName()`"
 file: /reference/method/getHostName
-description:
+description: "Returns the hostname of the system running the shell."
 ---
 name: ":method:`source/reference/method/getMemInfo()`"
 file: /reference/method/getMemInfo
-description:
+description: " Returns a document that reports the amount of memory used by the shell."
 ---
 name: ":method:`source/reference/method/hostname()`"
 file: /reference/method/hostname
-description:
+description: "Returns the hostname of the system running the shell."
 ---
-name: ":method:`source/reference/method/isWindows()`"
+name: ":method:`source/reference/method/_isWindows()`"
 file: /reference/method/isWindows
-description:
+description: "Returns ``true`` if the shell runs on a Windows system; ``false`` if a Unix or Linux system."
 ---
 name: ":method:`source/reference/method/listFiles()`"
 file: /reference/method/listFiles
-description:
+description: "Returns an array of documents that give the name and size of each object in the directory."
 ---
 name: ":method:`source/reference/method/load()`"
 file: /reference/method/load
-description:
+description: "Loads and runs a JavaScript file in the shell."
 ---
 name: ":method:`source/reference/method/ls()`"
 file: /reference/method/ls
-description:
+description: "Returns a list of the files in the current directory."
 ---
 name: ":method:`source/reference/method/md5sumFile()`"
 file: /reference/method/md5sumFile
-description:
+description: "The :term:`md5` hash of the specified file."
 ---
 name: ":method:`source/reference/method/mkdir()`"
 file: /reference/method/mkdir
-description:
+description: "Creates a directory at the specified path."
 ---
 name: ":method:`source/reference/method/pwd()`"
 file: /reference/method/pwd
-description:
+description: "Returns the current directory."
 ---
 name: ":method:`source/reference/method/quit()`"
 file: /reference/method/quit
-description:
+description: "Exits the current shell session."
 ---
 name: ":method:`source/reference/method/rand()`"
 file: /reference/method/rand
-description:
+description: "Returns a random number between ``0`` and ``1``."
 ---
 name: ":method:`source/reference/method/removeFile()`"
 file: /reference/method/removeFile
-description:
+description: "Removes the specified file from the local file system."
 ---
 name: ":method:`source/reference/method/resetDbpath()`"
 file: /reference/method/resetDbpath
-description:
+description: "For internal use."
 ---
 name: ":method:`source/reference/method/srand()`"
 file: /reference/method/srand
-description:
+description: "For internal use."
 ...