Update documentation

Signed-off-by: lisrte <laurent.issertial@rte-france.com>
powsybl · Dec 12, 2024 · 46c0270 · 46c0270
1 parent cae21e0
commit 46c0270
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/user_guide/dynamic.rst b/docs/user_guide/dynamic.rst
@@ -93,5 +93,7 @@ To run a Dynawo simulation:
     results = sim.run(network, model_mapping, event_mapping, variables_mapping, start_time, end_time)
     # getting the results
     results.status()
+    results.status_text() # error description if the simulation fails
     results.curves() # dataframe containing the mapped curves
-    results.final_state_values() # dataframe containing the mapped final state values
+    results.final_state_values() # dataframe containing the mapped final state values
+    results.timeline() # dataframe containing the simulation timeline
diff --git a/pypowsybl/dynamic/impl/simulation_result.py b/pypowsybl/dynamic/impl/simulation_result.py
@@ -22,11 +22,11 @@ def __init__(self, handle: _pp.JavaHandle) -> None:
         self._timeline = create_data_frame_from_series_array(_pp.get_timeline(self._handle))
 
     def status(self) -> DynamicSimulationStatus:
-        """Status of the simulation"""
+        """Status of the simulation (SUCCESS or FAILURE)"""
         return self._status
 
     def status_text(self) -> str:
-        """Status text of the simulation"""
+        """Status text of the simulation (failure description or empty if success)"""
         return self._status_text
 
     def curves(self) -> pd.DataFrame: