DOC: Update docstrings

octue · cortadocodes · May 30, 2025 · May 30, 2025 · May 30, 2025 · May 30, 2025
commit ddbb536f1f0115aee45471127d735a1c0d94707f
diff --git a/octue/cloud/pub_sub/service.py b/octue/cloud/pub_sub/service.py
@@ -401,7 +401,7 @@ def wait_for_answer(
         :param float|int maximum_heartbeat_interval: the maximum amount of time (in seconds) allowed between child heartbeats before an error is raised
         :param bool raise_errors:
         :raise TimeoutError: if the timeout is exceeded
-        :return dict: dictionary containing the keys "output_values" and "output_manifest"
+        :return dict: dictionary containing the keys "output_values", "output_manifest", "success", and for a failed analysis, "exception"
         """
         if subscription.is_push_subscription:
             raise octue.exceptions.NotAPullSubscription(

diff --git a/octue/resources/child.py b/octue/resources/child.py
@@ -113,7 +113,7 @@ def ask(
         :param float|int maximum_heartbeat_interval: the maximum amount of time (in seconds) allowed between child heartbeats before an error is raised
         :raise TimeoutError: if the timeout is exceeded while waiting for an answer
         :raise Exception: if the question raises an error and `raise_errors=True`
-        :return dict|octue.cloud.pub_sub.subscription.Subscription|Exception|None, str: for a synchronous question, a dictionary containing the keys "output_values" and "output_manifest" from the result (or just an exception if the question fails), and the question UUID; for a question with a push endpoint, the push subscription and the question UUID; for an asynchronous question, `None` and the question UUID
+        :return dict|octue.cloud.pub_sub.subscription.Subscription|Exception|None, str: for a synchronous question, a dictionary containing the keys "output_values", "output_manifest", and "success" from the result (or just an exception if the question fails), and the question UUID; for a question with a push endpoint, the push subscription and the question UUID; for an asynchronous question, `None` and the question UUID
         """
         prevent_retries_when = prevent_retries_when or []