From 55f0172df890e5fefd9cf90a479d3ce6067bd2c5 Mon Sep 17 00:00:00 2001 From: tamarzanzouri Date: Mon, 29 Jul 2024 14:41:43 -0400 Subject: [PATCH] updated docstrings --- robot-server/robot_server/runs/error_recovery_models.py | 3 ++- robot-server/robot_server/runs/router/base_router.py | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/robot-server/robot_server/runs/error_recovery_models.py b/robot-server/robot_server/runs/error_recovery_models.py index c7a00c3ec63..e36cc576b01 100644 --- a/robot-server/robot_server/runs/error_recovery_models.py +++ b/robot-server/robot_server/runs/error_recovery_models.py @@ -76,5 +76,6 @@ class ErrorRecoveryPolicies(BaseModel): policyRules: List[ErrorRecoveryRule] = Field( ..., - description="The criteria that must be met for this rule to be applied.", + description="A list or error recovery rules to apply for a run's recovery management." + "The rules are evaluated first-to-last. The first exact match will dectate recovery management.", ) diff --git a/robot-server/robot_server/runs/router/base_router.py b/robot-server/robot_server/runs/router/base_router.py index 7c3d4739f5c..b4bc4baf3fe 100644 --- a/robot-server/robot_server/runs/router/base_router.py +++ b/robot-server/robot_server/runs/router/base_router.py @@ -371,7 +371,7 @@ async def update_run( summary="Set run policies", description=dedent( """ - When in error recovery, add the ability to ignore errors for commands. + Update how to handle different kinds of command failures. The following rules will persist during the run. """ ),