Update return info in doc strings

meilisearch · May 10, 2023 · 50e58ea · 50e58ea
1 parent 3442fae
commit 50e58ea
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/meilisearch/client.py b/meilisearch/client.py
@@ -477,7 +477,8 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskResults:
         Returns
         -------
         task:
-            Limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
+            TaskResult instance containing limit, from, next and results containing a list of all
+            enqueued, processing, succeeded or failed tasks.
 
         Raises
         ------
@@ -497,7 +498,7 @@ def get_task(self, uid: int) -> Task:
         Returns
         -------
         task:
-            Information about the processed asynchronous task.
+            Task instance containing information about the processed asynchronous task.
 
         Raises
         ------
@@ -566,7 +567,7 @@ def wait_for_task(
         Returns
         -------
         task:
-            Dictionary containing information about the processed asynchronous task.
+            Task instance containing information about the processed asynchronous task.
 
         Raises
         ------

diff --git a/meilisearch/task.py b/meilisearch/task.py
@@ -38,7 +38,8 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskResults:
         Returns
         -------
         task:
-            Limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
+            TaskResults instance contining limit, from, next and results containing a list of all
+            enqueued, processing, succeeded or failed tasks.
 
         Raises
         ------
@@ -64,7 +65,7 @@ def get_task(self, uid: int) -> Task:
         Returns
         -------
         task:
-            Dictionary containing information about the status of the asynchronous task.
+            Task instance containing information about the processed asynchronous task.
 
         Raises
         ------
@@ -147,7 +148,7 @@ def wait_for_task(
         Returns
         -------
         task:
-            Information about the processed asynchronous task.
+            Task instance containing information about the processed asynchronous task.
 
         Raises
         ------