Skip to content

Commit 4db1961

Browse files
committed
minor: documentation fixes
options -> opts in ReplSetConnection
1 parent 8db4eb7 commit 4db1961

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

lib/mongo/repl_set_connection.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,20 @@ class ReplSetConnection < Connection
3333
#
3434
# @param [Array] seeds "host:port" strings
3535
#
36-
# @option options [String] :rs_name (nil) The name of the replica set to connect to. You
36+
# @option opts [String] :rs_name (nil) The name of the replica set to connect to. You
3737
# can use this option to verify that you're connecting to the right replica set.
38-
# @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
38+
# @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
3939
# propogated to DB objects instantiated off of this Connection. This
4040
# default can be overridden upon instantiation of any DB by explicity setting a :safe value
4141
# on initialization.
42-
# @option options [:primary, :secondary] :read (:primary) The default read preference for Mongo::DB
42+
# @option opts [:primary, :secondary] :read (:primary) The default read preference for Mongo::DB
4343
# objects created from this connection object. If +:secondary+ is chosen, reads will be sent
4444
# to one of the closest available secondary nodes. If a secondary node cannot be located, the
4545
# read will be sent to the primary.
46-
# @option options [Logger] :logger (nil) Logger instance to receive driver operation log.
47-
# @option options [Integer] :pool_size (1) The maximum number of socket connections allowed per
46+
# @option opts [Logger] :logger (nil) Logger instance to receive driver operation log.
47+
# @option opts [Integer] :pool_size (1) The maximum number of socket connections allowed per
4848
# connection pool. Note: this setting is relevant only for multi-threaded applications.
49-
# @option options [Float] :pool_timeout (5.0) When all of the connections a pool are checked out,
49+
# @option opts [Float] :pool_timeout (5.0) When all of the connections a pool are checked out,
5050
# this is the number of seconds to wait for a new connection to be released before throwing an exception.
5151
# Note: this setting is relevant only for multi-threaded applications.
5252
# @option opts [Float] :op_timeout (nil) The number of seconds to wait for a read operation to time out.

0 commit comments

Comments
 (0)