Fix docstrings

precice · Jan 9, 2025 · 9f317d6 · 9f317d6
1 parent 5bedd24
commit 9f317d6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/micro_manager/adaptivity/global_adaptivity.py b/micro_manager/adaptivity/global_adaptivity.py
@@ -31,8 +31,6 @@ def __init__(
         ----------
         configurator : object of class Config
             Object which has getter functions to get parameters defined in the configuration file.
-        logger : object of logging
-            Logger defined from the standard package logging
         global_number_of_sims : int
             Total number of simulations in the macro-micro coupled problem.
         global_ids : list

diff --git a/micro_manager/adaptivity/local_adaptivity.py b/micro_manager/adaptivity/local_adaptivity.py
@@ -18,6 +18,8 @@ def __init__(self, configurator, rank, comm, num_sims) -> None:
         ----------
         configurator : object of class Config
             Object which has getter functions to get parameters defined in the configuration file.
+        rank : int
+            Rank of the current MPI process.
         comm : MPI.COMM_WORLD
             Global communicator of MPI.
         num_sims : int
@@ -142,6 +144,8 @@ def log_metrics(self, n: int) -> None:
 
         Parameters
         ----------
+        n : int
+            Current time step
         """
         # MPI Gather is necessary as local adaptivity only stores local data
         local_active_sims = np.count_nonzero(self._is_sim_active)

diff --git a/micro_manager/micro_manager.py b/micro_manager/micro_manager.py
@@ -635,9 +635,8 @@ def _solve_micro_simulations(self, micro_sims_input: list, dt: float) -> tuple:
 
         Returns
         -------
-        micro_sims_output : list
-            List of dicts in which keys are names of data and the values are the data of the output of the micro
-            simulations.
+        tuple
+            A tuple of micro_sims_output (list of Dicts) and dummy adaptivity computation CPU time.
         """
         micro_sims_output: list[dict] = [None] * self._local_number_of_sims
 
@@ -713,9 +712,8 @@ def _solve_micro_simulations_with_adaptivity(
 
         Returns
         -------
-        micro_sims_output : list
-            List of dicts in which keys are names of data and the values are the data of the output of the micro
-            simulations.
+        tuple
+            A tuple of micro_sims_output (list of Dicts) and adaptivity computation CPU time.
         """
         adaptivity_cpu_time = 0.0