Skip to content

Commit 47f9abb

Browse files
committed
RUBY-891 Add note for spec helper methods
1 parent cfaa191 commit 47f9abb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

spec/spec_helper.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ def sharded?
100100
end
101101

102102
# Determine whether the single address provided is a replica set member.
103+
# @note To run the specs relying on this to return true,
104+
# start a replica set and set the environment variable
105+
# MONGODB_ADDRESSES to the address of a single member.
103106
#
104107
# @since 2.0.0
105108
def single_rs_member?
@@ -108,6 +111,9 @@ def single_rs_member?
108111
end
109112

110113
# Determine whether the single address provided is a mongos.
114+
# @note To run the specs relying on this to return true,
115+
# start a sharded cluster and set the environment variable
116+
# MONGODB_ADDRESSES to the address of a single mongos.
111117
#
112118
# @since 2.0.0
113119
def single_mongos?

0 commit comments

Comments
 (0)