update docs with new behavior

maximpertsov · Aug 20, 2024 · 5b886c5 · 5b886c5
1 parent 13d2817
commit 5b886c5
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/proto/viam/robot/v1/robot.proto b/proto/viam/robot/v1/robot.proto
@@ -410,7 +410,8 @@ message ResourceStatus {
   // revision of the last config that successfully updated this resource.
   string revision = 4;
 
-  // error details for a resource that is in an unhealthy state.
+  // error details for a resource. This is guaranteed to be null if the
+  // resource is ready and non-null if the resource unhealthy.
   string error = 5;
 }