Documentation updates for yard doc errors

lib/mongo/auth/cr/conversation.rb

@@ -102,7 +102,6 @@ def start
         #   Conversation.new(user, "admin")
         #
         # @param [ Auth::User ] user The user to converse about.
-        # @param [ String ] database The database to authenticate against.
         #
         # @since 2.0.0
         def initialize(user)

lib/mongo/error/invalid_bulk_operation.rb

@@ -25,7 +25,8 @@ class InvalidBulkOperation < Error
       # @example Instantiate the exception.
       #   Mongo::Error::InvalidBulkOperation.new(name)
       #
-      # @param [ String ] name The attempted operation name.
+      # @param [ String ] type The bulk operation type.
+      # @param [ Hash ] operation The bulk operation.
       #
       # @since 2.0.0
       def initialize(type, operation)

lib/mongo/operation/aggregate.rb

@@ -31,12 +31,13 @@ module Operation
     #     :db_name => 'test_db'
     #   })
     #
-    # @param [ Hash ] spec The specifications for the operation.
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
     #
-    # @option spec :selector [ Hash ] The aggregate selector.
-    # @option spec :db_name [ String ] The name of the database on which
-    #   the operation should be executed.
-    # @option spec :options [ Hash ] Options for the aggregate command.
+    #   option spec :selector [ Hash ] The aggregate selector.
+    #   option spec :db_name [ String ] The name of the database on which
+    #     the operation should be executed.
+    #   option spec :options [ Hash ] Options for the aggregate command.
     #
     # @since 2.0.0
     class Aggregate

lib/mongo/operation/command.rb

@@ -20,14 +20,13 @@ module Operation
     # @example Create the command operation.
     #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
     #
-    # @note A command is actually a query on the virtual '$cmd' collection.
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the command.
     #
-    # @param [ Hash ] spec The specifications for the command.
-    #
-    # @option spec :selector [ Hash ] The command selector.
-    # @option spec :db_name [ String ] The name of the database on which
+    #   option spec :selector [ Hash ] The command selector.
+    #   option spec :db_name [ String ] The name of the database on which
     #   the command should be executed.
-    # @option spec :options [ Hash ] Options for the command.
+    #   option spec :options [ Hash ] Options for the command.
     #
     # @since 2.0.0
     class Command

lib/mongo/operation/kill_cursors.rb

@@ -20,9 +20,10 @@ module Operation
     # @example Create the kill cursors operation.
     #   Mongo::Operation::KillCursor.new({ :cursor_ids => [1, 2] })
     #
-    # @param [ Hash ] spec The specifications for the operation.
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
     #
-    # @option spec :cursor_ids [ Array ] The ids of cursors to kill.
+    #   option spec :cursor_ids [ Array ] The ids of cursors to kill.
     #
     # @since 2.0.0
     class KillCursors

lib/mongo/operation/map_reduce.rb

@@ -33,12 +33,13 @@ module Operation
     #     :db_name  => 'test_db'
     #   })
     #
-    # @param [ Hash ] spec The specifications for the operation.
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
     #
-    # @option spec :selector [ Hash ] The map reduce selector.
-    # @option spec :db_name [ String ] The name of the database on which
-    #   the operation should be executed.
-    # @option spec :options [ Hash ] Options for the map reduce command.
+    #   option spec :selector [ Hash ] The map reduce selector.
+    #   option spec :db_name [ String ] The name of the database on which
+    #     the operation should be executed.
+    #   option spec :options [ Hash ] Options for the map reduce command.
     #
     # @since 2.0.0
     class MapReduce

lib/mongo/operation/read/collections_info.rb

@@ -21,11 +21,12 @@ module Read
       # @example Create the collection names operation.
       #   Read::CollectionNames.new(:db_name => 'test-db')
       #
-      # @param [ Hash ] spec The specifications for the collection names operation.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the collection names operation.
       #
-      # @option spec :db_name [ String ] The name of the database whose collection
-      #   names is requested.
-      # @option spec :options [ Hash ] Options for the operation.
+      #   option spec :db_name [ String ] The name of the database whose collection
+      #     names is requested.
+      #   option spec :options [ Hash ] Options for the operation.
       #
       # @since 2.0.0
       class CollectionsInfo

lib/mongo/operation/read/get_more.rb

@@ -26,14 +26,15 @@ module Read
       #     :coll_name => 'test_coll'
       #   })
       #
-      # @param [ Hash ] spec The specifications for the operation.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the operation.
       #
-      # @option spec :to_return [ Integer ] The number of results to return.
-      # @option spec :cursor_id [ Integer ] The id of the cursor.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the operation should be executed.
-      # @option spec :coll_name [ String ] The name of the collection on which
-      #   the operation should be executed.
+      #   option spec :to_return [ Integer ] The number of results to return.
+      #   option spec :cursor_id [ Integer ] The id of the cursor.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the operation should be executed.
+      #   option spec :coll_name [ String ] The name of the collection on which
+      #     the operation should be executed.
       #
       # @since 2.0.0
       class GetMore

lib/mongo/operation/read/indexes.rb

@@ -23,10 +23,11 @@ module Read
       # @example Instantiate the operation.
       #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
       #
-      # @param [ Hash ] spec The specifications for the insert.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the insert.
       #
-      # @option spec :db_name [ String ] The name of the database.
-      # @option spec :coll_name [ String ] The name of the collection.
+      #   option spec :db_name [ String ] The name of the database.
+      #   option spec :coll_name [ String ] The name of the collection.
       #
       # @since 2.0.0
       class Indexes

lib/mongo/operation/read/list_collections.rb

@@ -25,11 +25,12 @@ module Read
       #
       # @note A command is actually a query on the virtual '$cmd' collection.
       #
-      # @param [ Hash ] spec The specifications for the command.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
       #
-      # @option spec :db_name [ String ] The name of the database whose list of
-      #   collection names is requested.
-      # @option spec :options [ Hash ] Options for the command.
+      #   option spec :db_name [ String ] The name of the database whose list of
+      #     collection names is requested.
+      #   option spec :options [ Hash ] Options for the command.
       #
       # @since 2.0.0
       class ListCollections

lib/mongo/operation/read/list_indexes.rb

@@ -25,13 +25,14 @@ module Read
       #
       # @note A command is actually a query on the virtual '$cmd' collection.
       #
-      # @param [ Hash ] spec The specifications for the command.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
       #
-      # @option spec :coll_name [ Hash ] The name of the collection whose index
-      #   info is requested.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the command should be executed.
-      # @option spec :options [ Hash ] Options for the command.
+      #   option spec :coll_name [ Hash ] The name of the collection whose index
+      #     info is requested.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the command should be executed.
+      #   option spec :options [ Hash ] Options for the command.
       #
       # @since 2.0.0
       class ListIndexes

lib/mongo/operation/read/query.rb

@@ -26,14 +26,15 @@ module Read
       #     :options => { :limit => 2 }
       #   })
       #
-      # @param [ Hash ] spec The specifications for the query.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the query.
       #
-      # @option spec :selector [ Hash ] The query selector.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the query should be run.
-      # @option spec :coll_name [ String ] The name of the collection on which
-      #   the query should be run.
-      # @option spec :options [ Hash ] Options for the query.
+      #   option spec :selector [ Hash ] The query selector.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the query should be run.
+      #   option spec :coll_name [ String ] The name of the collection on which
+      #     the query should be run.
+      #   option spec :options [ Hash ] Options for the query.
       #
       # @since 2.0.0
       class Query

lib/mongo/operation/write/bulk/bulk_delete.rb

@@ -31,19 +31,20 @@ module Write
       #     :write_concern => write_concern
       #   })
       #
-      # @param [ Hash ] spec The specifications for the delete.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the delete.
       #
-      # @option spec :deletes [ Array ] The delete documents.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the delete should be executed.
-      # @option spec :coll_name [ String ] The name of the collection on which
-      #   the delete should be executed.
-      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern
-      #   for this operation.
-      # @option spec :ordered [ true, false ] Whether the operations should be
-      #   executed in order.
-      # @option spec :options [Hash] Options for the command, if it ends up being a
-      #   write command.
+      #   option spec :deletes [ Array ] The delete documents.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the delete should be executed.
+      #   option spec :coll_name [ String ] The name of the collection on which
+      #     the delete should be executed.
+      #   option spec :write_concern [ Mongo::WriteConcern ] The write concern
+      #     for this operation.
+      #   option spec :ordered [ true, false ] Whether the operations should be
+      #     executed in order.
+      #   option spec :options [Hash] Options for the command, if it ends up being a
+      #     write command.
       #
       # @since 2.0.0
       class BulkDelete

lib/mongo/operation/write/bulk/bulk_insert.rb

@@ -33,16 +33,17 @@ module Write
       #     :ordered => false
       #   })
       #
-      # @param [ Hash ] spec The specifications for the insert.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the insert.
       #
-      # @option spec :documents [ Array ] The documents to insert.
-      # @option spec :db_name [ String ] The name of the database.
-      # @option spec :coll_name [ String ] The name of the collection.
-      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern.
-      # @option spec :ordered [ true, false ] Whether the operations should be
-      #   executed in order.
-      # @option spec :options [ Hash ] Options for the command, if it ends up being a
-      #   write command.
+      #   option spec :documents [ Array ] The documents to insert.
+      #   option spec :db_name [ String ] The name of the database.
+      #   option spec :coll_name [ String ] The name of the collection.
+      #   option spec :write_concern [ Mongo::WriteConcern ] The write concern.
+      #   option spec :ordered [ true, false ] Whether the operations should be
+      #     executed in order.
+      #   option spec :options [ Hash ] Options for the command, if it ends up being a
+      #     write command.
       #
       # @since 2.0.0
       class BulkInsert

lib/mongo/operation/write/bulk/bulk_insert/result.rb

@@ -37,7 +37,7 @@ class Result < Operation::Result
           #   Result.new(replies, inserted_ids)
           #
           # @param [ Protocol::Reply ] replies The wire protocol replies.
-          # @params [ Array<Object> ] ids The ids of the inserted documents.
+          # @param [ Array<Object> ] ids The ids of the inserted documents.
           #
           # @since 2.0.0
           def initialize(replies, ids)
@@ -88,7 +88,7 @@ class LegacyResult < Operation::Result
           #   Result.new(replies, inserted_ids)
           #
           # @param [ Protocol::Reply ] replies The wire protocol replies.
-          # @params [ Array<Object> ] ids The ids of the inserted documents.
+          # @param [ Array<Object> ] ids The ids of the inserted documents.
           #
           # @since 2.0.0
           def initialize(replies, ids)

lib/mongo/operation/write/bulk/bulk_update.rb

@@ -39,18 +39,19 @@ module Write
       #     :ordered => false
       #   })
       #
-      # @param [ Hash ] spec The specifications for the update.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the update.
       #
-      # @option spec :updates [ Array ] The update documents.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the query should be run.
-      # @option spec :coll_name [ String ] The name of the collection on which
-      #   the query should be run.
-      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern.
-      # @option spec :ordered [ true, false ] Whether the operations should be
-      #   executed in order.
-      # @option spec :options [ Hash ] Options for the command, if it ends up being a
-      #   write command.
+      #   option spec :updates [ Array ] The update documents.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the query should be run.
+      #   option spec :coll_name [ String ] The name of the collection on which
+      #     the query should be run.
+      #   option spec :write_concern [ Mongo::WriteConcern ] The write concern.
+      #   option spec :ordered [ true, false ] Whether the operations should be
+      #     executed in order.
+      #   option spec :options [ Hash ] Options for the command, if it ends up being a
+      #     write command.
       #
       # @since 2.0.0
       class BulkUpdate

lib/mongo/operation/write/create_index.rb

@@ -30,14 +30,15 @@ module Write
       #     :index_name => 'name_1_age_-1'
       #   })
       #
-      # @param [ Hash ] spec The specifications for the insert.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the insert.
       #
-      # @option spec :index [ Hash ] The index spec to create.
-      # @option spec :db_name [ String ] The name of the database.
-      # @option spec :coll_name [ String ] The name of the collection.
-      # @option spec :index_name [ String ] The name of the index.
-      # @option spec :options [ Hash ] Options for the command, if it ends up being a
-      #   write command.
+      #   option spec :index [ Hash ] The index spec to create.
+      #   option spec :db_name [ String ] The name of the database.
+      #   option spec :coll_name [ String ] The name of the collection.
+      #   option spec :index_name [ String ] The name of the index.
+      #   option spec :options [ Hash ] Options for the command, if it ends up being a
+      #     write command.
       #
       # @since 2.0.0
       class CreateIndex

lib/mongo/operation/write/create_user.rb

@@ -22,10 +22,11 @@ module Write
       # @example Initialize the operation.
       #   Write::CreateUser.new(:db_name => 'test', :user => user)
       #
-      # @param [ Hash ] spec The specifications for the create.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the create.
       #
-      # @option spec :user [ Auth::User ] The user to create.
-      # @option spec :db_name [ String ] The name of the database.
+      #   option spec :user [ Auth::User ] The user to create.
+      #   option spec :db_name [ String ] The name of the database.
       #
       # @since 2.0.0
       class CreateUser

lib/mongo/operation/write/delete.rb

@@ -31,19 +31,20 @@ module Write
       #     :write_concern => write_concern
       #   })
       #
-      # @param [ Hash ] spec The specifications for the delete.
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the delete.
       #
-      # @option spec :delete [ Hash ] The delete document.
-      # @option spec :db_name [ String ] The name of the database on which
-      #   the delete should be executed.
-      # @option spec :coll_name [ String ] The name of the collection on which
-      #   the delete should be executed.
-      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern
-      #   for this operation.
-      # @option spec :ordered [ true, false ] Whether the operations should be
-      #   executed in order.
-      # @option spec :options [Hash] Options for the command, if it ends up being a
-      #   write command.
+      #   option spec :delete [ Hash ] The delete document.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the delete should be executed.
+      #   option spec :coll_name [ String ] The name of the collection on which
+      #     the delete should be executed.
+      #   option spec :write_concern [ Mongo::WriteConcern ] The write concern
+      #     for this operation.
+      #   option spec :ordered [ true, false ] Whether the operations should be
+      #     executed in order.
+      #   option spec :options [Hash] Options for the command, if it ends up being a
+      #     write command.
       #
       # @since 2.0.0
       class Delete