Document the GuiTestAssistant and ModalDialogTester #933
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rahulporuri
approved these changes
Apr 26, 2021
There was a problem hiding this comment.
Mostly LGTM. @corranwebster @mdickinson do you have any feedback?
Comment on lines
+159
to
+160
| When testing modal dialog related code the main recommendation for doing so is | ||
| try to avoid it. If you can, try testing the dialog in a non-modal fashion. Or, |
mdickinson
reviewed
Apr 26, 2021
|
|
||
| - :meth:`event_loop_until_condition` | ||
|
|
||
| Runs the real Qt event loop until the provided condition evaluates to True. |
There was a problem hiding this comment.
One current usage difficulty with GuiTestAssistant is figuring out which methods are context managers: some of the methods are designed to be used a context managers, and if used without a with statement do nothing instead. (We've had more than one bug in real code as a result of this.)
It would be worth clearly noting for each method whether its return value is intended to be used as a context manager or not.
…ion find_qt_widget problems)
aaronayres35
changed the title
rahulporuri
approved these changes
Apr 29, 2021
Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #904
This PR adds a "GUI Testing" section to the documentation describing the
GuiTestAssistantandModalDialogTester.