@@ -271,17 +271,18 @@ def waitSignal(self, signal=None, timeout=1000, raising=None, check_params_cb=No
271
271
This defaults to ``True`` unless ``qt_wait_signal_raising = false``
272
272
is set in the config.
273
273
:param Callable check_params_cb:
274
- Optional callable(*parameters) that compares the provided signal parameters to some expected parameters.
274
+ Optional `` callable(*parameters)`` that compares the provided signal parameters to some expected parameters.
275
275
It has to match the signature of ``signal`` (just like a slot function would) and return ``True`` if
276
276
parameters match, ``False`` otherwise.
277
277
:returns:
278
278
``SignalBlocker`` object. Call ``SignalBlocker.wait()`` to wait.
279
279
280
280
.. note::
281
- Cannot have both ``signals`` and ``timeout`` equal ``None``, or
282
- else you will block indefinitely. We throw an error if this occurs.
281
+ Cannot have both ``signals`` and ``timeout`` equal ``None``, or
282
+ else you will block indefinitely. We throw an error if this occurs.
283
283
284
- .. note:: This method is also available as ``wait_signal`` (pep-8 alias)
284
+ .. note::
285
+ This method is also available as ``wait_signal`` (pep-8 alias)
285
286
"""
286
287
if raising is None :
287
288
raising_val = self ._request .config .getini ('qt_wait_signal_raising' )
@@ -335,12 +336,16 @@ def waitSignals(self, signals=None, timeout=1000, raising=None, check_params_cbs
335
336
Instead of a specific callable, ``None`` can be provided, to disable parameter checking for the
336
337
corresponding signal.
337
338
If the number of callbacks doesn't match the number of signals ``ValueError`` will be raised.
338
- :param str order: determines the order in which to expect signals
339
- * ``"none"``: no order is enforced
340
- * ``"strict"``: signals have to be emitted strictly in the provided order
341
- (e.g. fails when expecting signals [a, b] and [a, a, b] is emitted)
342
- * ``"simple"``: like "strict", but signals may be emitted in-between the provided ones, e.g. expected
343
- ``signals`` == [a, b, c] and actually emitted signals = [a, a, b, a, c] works (would fail with "strict")
339
+ :param str order:
340
+ Determines the order in which to expect signals:
341
+
342
+ - ``"none"``: no order is enforced
343
+ - ``"strict"``: signals have to be emitted strictly in the provided order
344
+ (e.g. fails when expecting signals [a, b] and [a, a, b] is emitted)
345
+ - ``"simple"``: like "strict", but signals may be emitted in-between the provided ones, e.g. expected
346
+ ``signals == [a, b, c]`` and actually emitted ``signals = [a, a, b, a, c]`` works
347
+ (would fail with ``"strict"``).
348
+
344
349
:returns:
345
350
``MultiSignalBlocker`` object. Call ``MultiSignalBlocker.wait()``
346
351
to wait.
0 commit comments