Skip to content

Commit 2165f77

Browse files
committed
Added "versionadded" sections to the documentation
1 parent a48b50b commit 2165f77

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ created earlier::
140140
Waiting for threads, processes, etc.
141141
====================================
142142

143+
.. versionadded:: 1.2
144+
143145
If your program has long running computations running in other threads or
144146
processes, you can use :meth:`qtbot.waitSignal <pytestqt.plugin.QtBot.waitSignal>`
145147
to block a test until a signal is emitted (such as ``QThread.finished``) or a
@@ -164,6 +166,8 @@ ensuring the results are correct::
164166
Exceptions in virtual methods
165167
=============================
166168

169+
.. versionadded:: 1.1
170+
167171
It is common in Qt programming to override virtual C++ methods to customize
168172
behavior, like listening for mouse events, implement drawing routines, etc.
169173

pytestqt/plugin.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,8 @@ def stopForInteraction(self):
239239

240240
def waitSignal(self, signal=None, timeout=1000):
241241
"""
242+
.. versionadded:: 1.2
243+
242244
Stops current test until a signal is triggered.
243245
244246
Used to stop the control flow of a test until a signal is emitted, or
@@ -267,7 +269,6 @@ def waitSignal(self, signal=None, timeout=1000):
267269
.. note::
268270
Cannot have both ``signals`` and ``timeout`` equal ``None``, or
269271
else you will block indefinitely. We throw an error if this occurs.
270-
271272
"""
272273
blocker = SignalBlocker(timeout=timeout)
273274
if signal is not None:

0 commit comments

Comments
 (0)