Skip to content

Commit 50e58ea

Browse files
committed
Update return info in doc strings
1 parent 3442fae commit 50e58ea

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

meilisearch/client.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,8 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskResults:
477477
Returns
478478
-------
479479
task:
480-
Limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
480+
TaskResult instance containing limit, from, next and results containing a list of all
481+
enqueued, processing, succeeded or failed tasks.
481482
482483
Raises
483484
------
@@ -497,7 +498,7 @@ def get_task(self, uid: int) -> Task:
497498
Returns
498499
-------
499500
task:
500-
Information about the processed asynchronous task.
501+
Task instance containing information about the processed asynchronous task.
501502
502503
Raises
503504
------
@@ -566,7 +567,7 @@ def wait_for_task(
566567
Returns
567568
-------
568569
task:
569-
Dictionary containing information about the processed asynchronous task.
570+
Task instance containing information about the processed asynchronous task.
570571
571572
Raises
572573
------

meilisearch/task.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskResults:
3838
Returns
3939
-------
4040
task:
41-
Limit, from, next and results containing a list of all enqueued, processing, succeeded or failed tasks.
41+
TaskResults instance contining limit, from, next and results containing a list of all
42+
enqueued, processing, succeeded or failed tasks.
4243
4344
Raises
4445
------
@@ -64,7 +65,7 @@ def get_task(self, uid: int) -> Task:
6465
Returns
6566
-------
6667
task:
67-
Dictionary containing information about the status of the asynchronous task.
68+
Task instance containing information about the processed asynchronous task.
6869
6970
Raises
7071
------
@@ -147,7 +148,7 @@ def wait_for_task(
147148
Returns
148149
-------
149150
task:
150-
Information about the processed asynchronous task.
151+
Task instance containing information about the processed asynchronous task.
151152
152153
Raises
153154
------

0 commit comments

Comments
 (0)