updates docstrings

Author: justin-cechmanek

redisvl/index/index.py

@@ -822,11 +822,11 @@ def _query(self, query: BaseQuery) -> List[Dict[str, Any]]:
     def query(self, query: Union[BaseQuery, AggregationQuery]) -> List[Dict[str, Any]]:
         """Execute a query on the index.
 
-        This method takes a BaseQuery object directly, runs the search, and
+        This method takes a BaseQuery or AggregationQuery object directly, and
         handles post-processing of the search.
 
         Args:
-            query (BaseQuery): The query to run.
+            query (Union[BaseQuery, AggregateQuery]): The query to run.
 
         Returns:
             List[Result]: A list of search results.
@@ -1498,7 +1498,7 @@ async def query(
         the search, and handles post-processing of the search.
 
         Args:
-            query Union(BaseQuery, AggregationQuery): The query to run.
+            query (Union[BaseQuery, AggregateQuery]): The query to run.
 
         Returns:
             List[Result]: A list of search results.

redisvl/query/aggregate.py

@@ -45,7 +45,7 @@ def __init__(
         dialect: int = 2,
     ):
         """
-        Instantiages a HybridQuery object.
+        Instantiates a HybridQuery object.
 
         Args:
             text (str): The text to search for.

redisvl/query/query.py

@@ -795,6 +795,16 @@ def stopwords(self):
         return self._stopwords
 
     def _set_stopwords(self, stopwords: Optional[Union[str, Set[str]]] = "english"):
+        """Set the stopwords to use in the query.
+        Args:
+            stopwords (Optional[Union[str, Set[str]]]): The stopwords to use. If a string
+                such as "english" "german" is provided then a default set of stopwords for that
+                language will be used. if a list, set, or tuple of strings is provided then those
+                will be used as stopwords. Defaults to "english". if set to "None" then no stopwords
+                will be removed.
+        Raises:
+            TypeError: If the stopwords are not a set, list, or tuple of strings.
+        """
         if not stopwords:
             self._stopwords = set()
         elif isinstance(stopwords, str):