Skip to content

Commit e52181a

Browse files
committed
Add small doc change: make it clear that one can access SignalTimeoutError from qtbot
1 parent bd5db81 commit e52181a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,14 @@ raising
170170
.. versionadded:: 1.4
171171

172172
Additionally, you can pass ``raising=True`` to raise a
173-
:class:`SignalTimeoutError` if the timeout is reached before the signal
174-
is triggered::
173+
:class:`qtbot.SignalTimeoutError <SignalTimeoutError>` if the timeout is
174+
reached before the signal is triggered::
175175

176176
def test_long_computation(qtbot):
177177
...
178178
with qtbot.waitSignal(app.worker.finished, raising=True) as blocker:
179179
app.worker.start()
180-
# if timeout is reached, SignalTimeoutError will be raised at this point
180+
# if timeout is reached, qtbot.SignalTimeoutError will be raised at this point
181181
assert_application_results(app)
182182

183183

@@ -199,7 +199,7 @@ the new ``raising`` parameter::
199199
w.start()
200200

201201
# this will be reached after all workers emit their "finished"
202-
# signal or a SignalTimeoutError will be raised
202+
# signal or a qtbot.SignalTimeoutError will be raised
203203
assert_application_results(app)
204204

205205
Exceptions in virtual methods

0 commit comments

Comments
 (0)