Fix in doc of visualise.optimization_stats (#1390)

* Fixed doc example from generic call (that did not exists) to apropriate call * Marked code as codeblocks
ICB-DCM · May 15, 2024 · 049493c · 049493c
1 parent 63c5662
commit 049493c
Showing 1 changed file with 37 additions and 27 deletions.
diff --git a/pypesto/visualize/optimization_stats.py b/pypesto/visualize/optimization_stats.py
@@ -53,15 +53,19 @@ def optimization_run_properties_one_plot(
 
     Examples
     --------
-    optimization_properties_per_multistart(
-        result1,
-        properties_to_plot=['time'],
-        colors=[.5, .9, .9, .3])
-
-    optimization_properties_per_multistart(
-        result1,
-        properties_to_plot=['time', 'n_grad'],
-        colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])
+    .. code-block:: python
+
+        optimization_run_properties_one_plot(
+            result1,
+            properties_to_plot=['time'],
+            colors=[.5, .9, .9, .3]
+        )
+
+        optimization_run_properties_one_plot(
+            result1,
+            properties_to_plot=['time', 'n_grad'],
+            colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
+        )
     """
     if properties_to_plot is None:
         properties_to_plot = [
@@ -156,24 +160,30 @@ def optimization_run_properties_per_multistart(
 
     Examples
     --------
-    optimization_properties_per_multistart(
-        result1,
-        properties_to_plot=['time'],
-        colors=[.5, .9, .9, .3])
-
-    optimization_properties_per_multistart(
-        [result1, result2],
-        properties_to_plot=['time'],
-        colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])
-
-    optimization_properties_per_multistart(
-        result1,
-        properties_to_plot=['time', 'n_grad'],
-        colors=[.5, .9, .9, .3])
-
-    optimization_properties_per_multistart(
-        [result1, result2], properties_to_plot=['time', 'n_fval'],
-        colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]])
+    .. code-block:: python
+
+        optimization_run_properties_per_multistart(
+            result1,
+            properties_to_plot=['time'],
+            colors=[.5, .9, .9, .3]
+        )
+
+        optimization_run_properties_per_multistart(
+            [result1, result2],
+            properties_to_plot=['time'],
+            colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
+        )
+
+        optimization_run_properties_per_multistart(
+            result1,
+            properties_to_plot=['time', 'n_grad'],
+            colors=[.5, .9, .9, .3]
+        )
+
+        optimization_run_properties_per_multistart(
+            [result1, result2], properties_to_plot=['time', 'n_fval'],
+            colors=[[.5, .9, .9, .3], [.2, .1, .9, .5]]
+        )
     """
     if properties_to_plot is None:
         properties_to_plot = [