Update ReplanningFlow.py

ReplanningFlow.py

@@ -4,6 +4,20 @@ from aiflows.base_flows import CircularFlow
 from flow_modules.Tachi67.PlanWriterFlowModule import PlanWriterFlow
 
 class ReplanningFlow(PlanWriterFlow):
+    """This flow inherits from PlanWriterFlow.
+     By changing prompts and injecting proper information to the controller and the PlanGenerator, we are able to achieve the replanning.
+
+    *Input Interface*:
+    - `goal` (str): information on the old plan (e.g. what is wrong)
+    - `plan` (str): the old plan
+    - `plan_file_location` (str): the location of the old plan file
+    
+    *Output Interface*:
+    - `plan` (str): the new plan
+    - `status`: "finished" or "unfinished"
+    - `summary` (str): summary of the flow, will be written to the log file of the caller flow.
+    - `result` (str): result of the flow, will be passed to the controller of the caller flow.
+    """
     def _on_reach_max_round(self):
         self._state_update_dict({
             "plan": "The maximum amount of rounds was reached before the model generated the plan.",