Skip to content

Commit 0f1ffb4

Browse files
committed
fix deadlock docs
1 parent 98e8252 commit 0f1ffb4

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/Features/deadlock.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ In order to take advantage of this feature, set deadlock detection option to Tru
1010

1111
Detect_deadlock: True
1212

13-
Then use the :code:`simulate_until_deadlock` method to return the times to deadlock from each state::
13+
Then use the :code:`simulate_until_deadlock` method. The attribute :code:`times_to_deadlock` contains the times to deadlock from each state::
1414

1515
>>> import ciw
1616
>>> Q = ciw.Simulation(deadlock_params) # doctest:+SKIP
17-
>>> times = Q.simulate_until_deadlock() # doctest:+SKIP
17+
>>> Q.simulate_until_deadlock() # doctest:+SKIP
18+
>>> times = Q.times_to_deadlock # doctest:+SKIP
1819

1920
where :code:`times` is a dictionary with states as keys and times to deadlock as values. Note that :code:`Simulation_time` is ingnored in this case.
2021

0 commit comments

Comments
 (0)