pytest-dev / pytest-dev/pytest-qt
Suggestion for docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 455
- Forks
- 72
- Avg merge
- 12h 26m
- Merged PRs (30d)
- 1
Description
A quick suggestion for the docs. I'm new to Python for Qt and wasn't sure whether pytest-qt or Qt Test was best for starting out my tests or how the two were related.
Then I saw this blurb from the Qt World Summit website:
Both PySide and PyQt allow rapid prototyping and development of Qt applications using the Python programming language. However, the Qt Test framework is focused on C++, and only a subset of its functionality is available in Python. Together with the “unittest” module in the Python standard library (which exposes a heavyweight, xUnit-like API), this can make tests unnecessarily cumbersome to write. The pytest framework coupled with the pytest-qt plugin allows writing tests for Qt/Python code in a much more straightforward and fun way. It exposes the QTestLib API, but also adds various high-level functionality with an API which is more suitable for Python code. ...
Some of that text might be useful background info in the docs somewhere, maybe as a callout in the introduction page of the docs?
Just a thought. Hope it's helpful.
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 the documentation introduction page at intro.html and review how pytest-qt, Qt Test, and Python testing are currently explained. Use the linked Qt World Summit blurb as background, then determine whether a concise comparison or callout would clarify the relationship; done means the introduction addresses this newcomer question without adding unsupported claims.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100