Skip to content

Commit 853a5f4

Browse files
committed
address review
1 parent 5a845a5 commit 853a5f4

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

pymongo_vectorsearch_utils/index.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def create_vector_search_index(
9999
wait_until_complete: float | None = None,
100100
**kwargs: Any,
101101
) -> None:
102-
"""Experimental Utility function to create a vector search index
102+
"""Create a vector search index on the specified field.
103103
104104
Args:
105105
collection (Collection): MongoDB Collection
@@ -192,7 +192,7 @@ def drop_vector_search_index(
192192
*,
193193
wait_until_complete: float | None = None,
194194
) -> None:
195-
"""Drop a created vector search index.
195+
"""Drop an existing vector search index.
196196
197197
Args:
198198
collection (Collection): MongoDB Collection with index to be dropped.
@@ -219,7 +219,7 @@ def create_fulltext_search_index(
219219
wait_until_complete: float | None = None,
220220
**kwargs: Any,
221221
) -> None:
222-
"""Experimental Utility function to create an Atlas Search index
222+
"""Create a fulltext search index on the specified field(s).
223223
224224
Args:
225225
collection (Collection): MongoDB Collection
@@ -262,8 +262,7 @@ def wait_for_docs_in_index(
262262
embedding_field: str,
263263
n_docs: int,
264264
) -> bool:
265-
"""Inserts texts using the provided insert_func and then waits for texts
266-
to be indexed before returning.
265+
"""Wait until the given number of documents are indexed by the given index.
267266
268267
Args:
269268
collection (Collection): A MongoDB Collection.

0 commit comments

Comments
 (0)