Skip to content

Commit c01071f

Browse files
committed
update docstring again
1 parent 15f39af commit c01071f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

pyomo/common/timing.py

+5-6
Original file line numberDiff line numberDiff line change
@@ -614,12 +614,11 @@ class HierarchicalTimer(object):
614614
When implementing an algorithm, it is often useful to collect detailed
615615
hierarchical timing information. However, when communicating a timing
616616
profile, it is often best to retain only the most relevant information
617-
in a flattened data structure. In the following example, suppose a
618-
theoretical analysis tells us that either subroutine ``"c"`` or ``"f"``
619-
should be the bottleneck, depending on problem data. We would like to
620-
generate a timing profile that displays only the time spent in these
621-
two subroutines in a flattened structure so that they are easy to
622-
compare. To do this, we
617+
in a flattened data structure. In the following example, suppose we
618+
want to compare the time spent in the ``"c"`` and ``"f"`` subroutines.
619+
We would like to generate a timing profile that displays only the time
620+
spent in these two subroutines, in a flattened structure so that they
621+
are easy to compare. To do this, we
623622
624623
#. Ignore subroutines of ``"c"`` and ``"f"`` that are unnecessary for\
625624
this comparison

0 commit comments

Comments
 (0)