docs: clarify subtests progress output#14467
Merged
nicoddemus merged 1 commit intoMay 12, 2026
Merged
Conversation
Co-authored-by: OpenAI Codex <codex@openai.com>
1b4e0ad to
12c74d2
Compare
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 |
This file contains hidden or 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
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.
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