update docstring

Signed-off-by: Cindy Zhang <cindyzyx9@gmail.com>
ray-project · Apr 26, 2023 · 7ed8d5a · 7ed8d5a
1 parent ff8e255
commit 7ed8d5a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/python/ray/serve/_private/deployment_state.py b/python/ray/serve/_private/deployment_state.py
@@ -470,6 +470,11 @@ def check_ready(
                     - for PENDING_ALLOCATION, PENDING_INITIALIZATION, or FAILED states
                 version:
                     - for SUCCEEDED state
+            error_msg:
+                None:
+                    - for PENDING_ALLOCATION, PENDING_INITIALIZATION or SUCCEEDED states
+                str:
+                    - for FAILED state
         """
 
         # Check whether the replica has been allocated.