Update UpdatePlanAtomicFlow.py

UpdatePlanAtomicFlow.py

@@ -2,6 +2,16 @@
 from typing import Dict, Any
 from aiflows.base_flows.atomic import AtomicFlow
 class UpdatePlanAtomicFlow(AtomicFlow):
+    """This flow updates the plan file with the updated plan. The controller should pass the updated plan to this flow.
+    This design (controller reflect on the existing plan--update plan) is intended to let the controller more aware of the
+    plan it has. However one setback is that this process in then not deterministic.
+    
+    *Input Interface*
+    - `updated_plan`: the updated plan in string format
+    
+    *Output Interface*
+    - `result`: the result of the update plan operation
+    """
     def _check_input(self, input_data: Dict[str, Any]):
         assert "memory_files" in input_data, "memory_files not passed to UpdatePlanAtomicFlow.yaml"
         assert "plan" in input_data["memory_files"], "plan not in memory_files"