Skip to content

Commit a14d375

Browse files
committed
Fix documentation typos
1 parent b1b1a4a commit a14d375

File tree

6 files changed

+15
-14
lines changed

6 files changed

+15
-14
lines changed

lib/mongo/loggable.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module Loggable
2929
# @example Log a debug message.
3030
# log_debug('Message')
3131
#
32-
# @param [ String> ] message The message to log.
32+
# @param [ String ] message The message to log.
3333
#
3434
# @since 2.0.0
3535
def log_debug(message)
@@ -41,7 +41,7 @@ def log_debug(message)
4141
# @example Log a error message.
4242
# log_error('Message')
4343
#
44-
# @param [ String> ] message The message to log.
44+
# @param [ String ] message The message to log.
4545
#
4646
# @since 2.0.0
4747
def log_error(message)
@@ -53,7 +53,7 @@ def log_error(message)
5353
# @example Log a fatal message.
5454
# log_fatal('Message')
5555
#
56-
# @param [ String> ] message The message to log.
56+
# @param [ String ] message The message to log.
5757
#
5858
# @since 2.0.0
5959
def log_fatal(message)
@@ -65,7 +65,7 @@ def log_fatal(message)
6565
# @example Log a info message.
6666
# log_info('Message')
6767
#
68-
# @param [ String> ] message The message to log.
68+
# @param [ String ] message The message to log.
6969
#
7070
# @since 2.0.0
7171
def log_info(message)
@@ -77,7 +77,7 @@ def log_info(message)
7777
# @example Log a warn message.
7878
# log_warn('Message')
7979
#
80-
# @param [ String> ] message The message to log.
80+
# @param [ String ] message The message to log.
8181
#
8282
# @since 2.0.0
8383
def log_warn(message)

lib/mongo/protocol/insert.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ class Upconverter
119119
# Upconverter.new('users', documents)
120120
#
121121
# @param [ String ] collection The name of the collection.
122-
# @param [ Array<BSON::Document> ] document The documents.
122+
# @param [ Array<BSON::Document> ] documents The documents.
123123
# @param [ Hash ] options The options.
124124
#
125125
# @since 2.1.0

lib/mongo/protocol/kill_cursors.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ class KillCursors < Message
2828
# @example Kill the cursor on the server with id 1.
2929
# KillCursors.new([1])
3030
#
31-
# @param cursor_ids [Array<Fixnum>] The cursor ids to kill.
32-
# @param options [Hash] The additional kill cursors options.
31+
# @param [ Mongo::Database ] collection The collection.
32+
# @param [ Mongo::Database ] database The database.
33+
# @param [ Array<Fixnum> ] cursor_ids The cursor ids to kill.
3334
def initialize(collection, database, cursor_ids)
3435
@database = database
3536
@cursor_ids = cursor_ids

lib/mongo/protocol/reply.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,11 @@ class Upconverter
115115
# @example Create the upconverter.
116116
# Upconverter.new(docs, 1, 3)
117117
#
118-
# @param [ Array<BSON::Document> document The documents.
118+
# @param [ Array<BSON::Document> ] documents The documents.
119119
# @param [ Integer ] cursor_id The cursor id.
120120
# @param [ Integer ] starting_from The starting position.
121121
#
122-
# @sincce 2.1.0
122+
# @since 2.1.0
123123
def initialize(documents, cursor_id, starting_from)
124124
@documents = documents
125125
@cursor_id = cursor_id

lib/mongo/protocol/update.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ class Upconverter
140140
#
141141
# @param [ String ] collection The name of the collection.
142142
# @param [ Hash ] filter The filter.
143-
# @param [ Hash ] udpate The update.
143+
# @param [ Hash ] update The update.
144144
# @param [ Array<Symbol> ] flags The flags.
145145
#
146146
# @since 2.1.0

lib/mongo/uri.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,8 @@ def apply_transform(value, type = nil)
422422

423423
# Selects the output destination for an option.
424424
#
425-
# @param options [Hash] The base target.
426-
# @param group [Symbol] Group subtarget.
425+
# @param [Hash] uri_options The base target.
426+
# @param [Symbol] group Group subtarget.
427427
#
428428
# @return [Hash] The target for the option.
429429
def select_target(uri_options, group = nil)
@@ -465,7 +465,7 @@ def merge_uri_option(target, value, name)
465465
#
466466
# @param strategy [Symbol] The strategy for this option.
467467
# @param value [String] The value of the option.
468-
# @param options [Hash] The base option target.
468+
# @param uri_options [Hash] The base option target.
469469
def add_uri_option(strategy, value, uri_options)
470470
target = select_target(uri_options, strategy[:group])
471471
value = apply_transform(value, strategy[:type])

0 commit comments

Comments
 (0)