added docstrings

festim-dev · Oct 9, 2023 · 9035525 · 9035525
1 parent f72e22b
commit 9035525
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/festim/stepsize.py b/festim/stepsize.py
@@ -99,7 +99,16 @@ def adapt(self, t, nb_it, converged):
             ):
                 self.value.assign((next_milestone - t))
 
-    def next_milestone(self, current_time):
+    def next_milestone(self, current_time: float):
+        """Returns the next milestone that the simulation must pass.
+        Returns None if there are no more milestones.
+
+        Args:
+            current_time (float): current time.
+
+        Returns:
+            float: next milestone.
+        """
         if self.milestones is None:
             return None
         for milestone in self.milestones: