pytest-dev / pytest-dev/pytest-qt
waitUntil page should link to waitUntil API doc and/or demonstrate use of the timeout param
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 455
- Forks
- 72
- Avg merge
- 12h 26m
- Merged PRs (30d)
- 1
Description
Thanks for pytest-qt, it is a fantastic plugin. 😊
This is mostly a to-do-eventually for me, but writing it down in case someone else can pick it up earlier.
I was wanting to figure out whether waitUntil had a timeout parameter, but the top result on DDG is the waitUntil tutorial/demo page (source), which does not use the timeout= kwarg and does not link out to the API reference page (source).
Not a big deal, but either of those would have saved me a search. 😊
Thanks again!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/wait_until.rst, the tutorial/demo page identified in the issue, and compare it with the QtBot.waitUntil API documentation in src/pytestqt/qtbot.py. Update the tutorial to link to the API reference and/or show the timeout parameter, then verify the rendered documentation contains the helpful guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100