Add note about blocking call

QuEraComputing · Jun 11, 2024 · e8b6a28 · e8b6a28
1 parent b4a6694
commit e8b6a28
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/bloqade/submission/quera.py b/src/bloqade/submission/quera.py
@@ -113,6 +113,10 @@ def task_results(self, task_id: str) -> QuEraTaskResults:
         Returns:
             task_result (QuEraTaskResults):
                 Final result of a task previously submitted by using the task id.
+
+        Note:
+            This is a blocking call, meaning the function will not
+                return till the task has stopped.
         """
         return QuEraTaskResults(**self.queue_api.poll_task_results(task_id))