base: explain what OpCode.SUCCEEDED means for a Process

simonsobs · Aug 27, 2021 · 89a01d4 · 89a01d4
1 parent fcb9ba7
commit 89a01d4
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/ocs/base.py b/ocs/base.py
@@ -64,7 +64,8 @@ class OpCode(Enum):
     STOPPING = 4
 
     #: SUCCEEDED indicates that the Operation has terminated and has
-    #: indicated the Operation was successful.
+    #: indicated the Operation was successful.  This includes the case
+    #: of a Process that was asked to stop and has shut down cleanly.
     SUCCEEDED = 5
 
     #: FAILED indicates that the Operation has terminated with some