Skip to content

Commit b27df9d

Browse files
RUBY-3395 Add missing doc comments for indexes (#2930)
1 parent 10bfb18 commit b27df9d

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/mongo/search_index/view.rb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ def initialize(collection, options = {})
4646
#
4747
# @param [ Hash ] definition The definition of the search index.
4848
# @param [ nil | String ] name The name to give the new search index.
49+
# @param [ String ] type The type of the search index. Possible values
50+
# are 'search' and 'vectorSearch'. The default is 'search'.
4951
#
5052
# @return [ String ] the name of the new search index.
5153
def create_one(definition, name: nil, type: 'search')
@@ -56,7 +58,8 @@ def create_one(definition, name: nil, type: 'search')
5658
#
5759
# @param [ Array<Hash> ] indexes The description of the indexes to
5860
# create. Each element of the list must be a hash with a definition
59-
# key, and an optional name key.
61+
# key, an optional name key, and an optional type key. The type key
62+
# must be one of 'search' or 'vectorSearch'. The default is 'search'.
6063
#
6164
# @return [ Array<String> ] the names of the new search indexes.
6265
def create_many(indexes)

0 commit comments

Comments
 (0)