Skip to content

RUBY-3395 Add missing doc comments for indexes #2930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

RUBY-3395 Add missing doc comments for indexes #2930

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion lib/mongo/search_index/view.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ def initialize(collection, options = {})
#
# @param [ Hash ] definition The definition of the search index.
# @param [ nil | String ] name The name to give the new search index.
# @param [ String ] type The type of the search index. Possible values
# are 'search' and 'vectorSearch'. The default is 'search'.
#
# @return [ String ] the name of the new search index.
def create_one(definition, name: nil, type: 'search')
Expand All @@ -56,7 +58,8 @@ def create_one(definition, name: nil, type: 'search')
#
# @param [ Array<Hash> ] indexes The description of the indexes to
# create. Each element of the list must be a hash with a definition
# key, and an optional name key.
# key, an optional name key, and an optional type key. The type key
# must be one of 'search' or 'vectorSearch'. The default is 'search'.
#
# @return [ Array<String> ] the names of the new search indexes.
def create_many(indexes)
Expand Down