STY: Fixed docustring of the public funciton serialize_simulation

hnn_core/gui/gui.py

@@ -1451,24 +1451,7 @@ def _serialize_simulation(log_out, sim_data, simulation_list_widget):
 
 
 def serialize_simulation(simulations_data, simulation_name):
-    """
-        Serializes the simulation data for a given simulation name
-        into either a single CSV file
-        or a ZIP file containing multiple CSVs, depending on the number
-        of trials in the simulation.
-        Parameters:
-        - simulation_name (str): The name of the simulation to serialize.
-                                 This name is used to access the corresponding
-                                 data in the 'simulations' dictionary
-                                 of the instance.
-
-        Returns:
-        - tuple: A tuple where the first element is either
-                the CSV content (str) of a single trial
-                or the binary data of a ZIP file (bytes)
-                containing multiple CSV files, and the
-                second element is the file extension (either ".csv" or ".zip").
-    """
+    """Serialize a simulation in CSV or a ZIP file containing multiple CSVs"""
     simulation_data = simulations_data["simulation_data"]
     csv_trials_output = []
     # CSV file hearders