docs: clarify subtests progress output#14467
Conversation
Co-authored-by: OpenAI Codex <[email protected]>
1b4e0ad to
12c74d2
Compare
psf-chronographer
Bot
added
the
bot:chronographer:provided
There was a problem hiding this comment.
Pull request overview
This PR updates pytest’s subtests documentation to avoid misleading syntax highlighting in the rendered example output, and adds a brief explanation of the u progress marker behavior, with a corresponding changelog note (closes #13902).
Changes:
- Switch the subtests example output block to plain text rendering to prevent all
umarkers from being colored as “passing”. - Add a note explaining that
uis used for both passed and failed subtests and to consult the short summary for failures. - Add a documentation changelog fragment describing the clarification.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/en/how-to/subtests.rst | Renders the sample output as plain text and explains the u marker semantics to avoid misleading coloration. |
| changelog/13902.doc.rst | Adds a newsfragment noting the documentation clarification. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Backport to 9.0.x: 💚 backport PR created✅ Backport PR branch: Backported as #14468 🤖 @patchback |
(cherry picked from commit 7df5d80) Co-authored-by: 1Utkarsh1 <[email protected]> Co-authored-by: OpenAI Codex <[email protected]>
Summary
uprogress marker as passing.umarker is used for both passed and failed subtests, and that the summary shows which subtests failed.Closes #13902.
Testing
git diff --checkuv run --python 3.14 --with tox tox -e docs -- -qNotes