Merge remote-tracking branch 'jsiirola/solver-refactor' into solver-r…

…efactor
Pyomo · Feb 21, 2024 · 8c0cf59 · 8c0cf59
2 parents cf5dc9c + a906f9f
commit 8c0cf59
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/pyomo/contrib/solver/results.py b/pyomo/contrib/solver/results.py
@@ -164,10 +164,12 @@ class Results(ConfigDict):
     iteration_count: int
         The total number of iterations.
     timing_info: ConfigDict
-        A ConfigDict containing two pieces of information:
-            start_timestamp: UTC timestamp of when run was initiated
-            wall_time: elapsed wall clock time for entire process
-            timer: a HierarchicalTimer object containing timing data about the solve
+        A ConfigDict containing three pieces of information:
+            - ``start_timestamp``: UTC timestamp of when run was initiated
+            - ``wall_time``: elapsed wall clock time for entire process
+            - ``timer``: a HierarchicalTimer object containing timing data about the solve
+
+        Specific solvers may add other relevant timing information, as appropriate.
     extra_info: ConfigDict
         A ConfigDict to store extra information such as solver messages.
     solver_configuration: ConfigDict