search

pytest-dev / pytest-qt

pytest plugin for Qt (PyQt5/PyQt6 and PySide2/PySide6) application testing
https://pytest-qt.readthedocs.io
MIT License
403 stars 71 forks source link

Suggestion for docs #273

Open danielmcquillen opened 5 years ago

danielmcquillen commented 5 years ago

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.

nicoddemus commented 5 years ago

Thanks a lot @danielmcquillen, indeed this would be a nice addition to the docs. Would you like to open a PR with that? This would be a nice contribution, and can even be done directly from the GitHub UI. 😁