lib/mongo/cluster/topology/replica_set.rb in mongo-2.5.3 vs lib/mongo/cluster/topology/replica_set.rb in mongo-2.6.0
- old
+ new
@@ -1,6 +1,6 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
@@ -120,9 +120,17 @@
# ReplicaSet.new(options)
#
# @param [ Hash ] options The options.
# @param [ Monitoring ] monitoring The monitoring.
# @param [ Array<String> ] seeds The seeds.
+ #
+ # @option options [ Symbol ] :replica_set Name of the replica set to
+ # connect to. Can be left blank (either nil or the empty string are
+ # accepted) to discover the name from the seeds. If the seeds
+ # belong to different replica sets there is no guarantee which
+ # replica set is selected - in particular, the driver may choose
+ # the replica set name of a secondary if it returns its response
+ # prior to a primary belonging to a different replica set.
#
# @since 2.0.0
def initialize(options, monitoring, seeds = [])
@options = options
@monitoring = monitoring