Skip to content

Commit 5304701

Browse files
committed
RUBY-837 Slight update to options documentation
1 parent 505e9eb commit 5304701

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

lib/mongo/collection.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,8 @@ def update(selector, document, opts={})
550550
# The option is silently ignored by the server and unique index builds using the option will
551551
# fail if a duplicate value is detected.
552552
#
553-
# @note See the MongoDB documentation for a full list of supported options by server version.
553+
# @note Note that the options listed may be subset of those available.
554+
# See the MongoDB documentation for a full list of supported options by server version.
554555
#
555556
# @return [String] the name of the index created.
556557
def create_index(spec, opts={})
@@ -583,7 +584,8 @@ def create_index(spec, opts={})
583584
# The option is silently ignored by the server and unique index builds using the option will
584585
# fail if a duplicate value is detected.
585586
#
586-
# @note See the MongoDB documentation for a full list of supported options by server version.
587+
# @note Note that the options listed may be subset of those available.
588+
# See the MongoDB documentation for a full list of supported options by server version.
587589
#
588590
# @return [String] the name of the index.
589591
def ensure_index(spec, opts={})

lib/mongo/db.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,8 @@ def collections_info(coll_name=nil)
316316
# either we're in +strict+ mode and the collection
317317
# already exists or collection creation fails on the server.
318318
#
319-
# @note See the MongoDB documentation for a full list of supported options by server version.
319+
# @note Note that the options listed may be subset of those available.
320+
# Please see the MongoDB documentation for a full list of supported options by server version.
320321
#
321322
# @return [Mongo::Collection]
322323
def create_collection(name, opts={})

0 commit comments

Comments
 (0)