FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: clarify subtests progress output by 1Utkarsh1 · Pull Request #14467 · pytest-dev/pytest · GitHub

/ pytest Public

docs: clarify subtests progress output - #14467

Merged
nicoddemus merged 1 commit into
pytest-dev:mainfrom
1Utkarsh1:docs/clarify-subtests-progress-output
May 12, 2026
ConversationCommits (1)ChecksFiles changed
Merged

docs: clarify subtests progress output#14467
nicoddemus merged 1 commit into
pytest-dev:mainfrom
1Utkarsh1:docs/clarify-subtests-progress-output

Conversation

1Utkarsh1 commented May 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

  • Render the subtests example output as plain text so the docs do not color every u progress marker as passing.
  • Add a short note explaining that the compact u marker is used for both passed and failed subtests, and that the summary shows which subtests failed.
  • Add a short changelog fragment for the documentation clarification.

Closes #13902.

Testing

  • git diff --check
  • uv run --python 3.14 --with tox tox -e docs -- -q

Notes

  • The commit includes an AI co-author trailer, per the project PR template.

docs: clarify subtests progress output
12c74d2 
Co-authored-by: OpenAI Codex <codex@openai.com>
1Utkarsh1 force-pushed the docs/clarify-subtests-progress-output branch from 1b4e0ad to 12c74d2 Compare May 12, 2026 07:57
psf-chronographer Bot added the bot:chronographer:provided (automation) changelog entry is part of PR label May 12, 2026
1Utkarsh1 marked this pull request as ready for review May 12, 2026 08:09
Copilot AI review requested due to automatic review settings May 12, 2026 08:09
Copilot AI reviewed May 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 u markers from being colored as “passing”.
  • Add a note explaining that u is 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.

nicoddemus approved these changes May 12, 2026
View reviewed changes

nicoddemus left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks!

nicoddemus merged commit 7df5d80 into pytest-dev:main May 12, 2026
60 of 66 checks passed

patchback Bot commented May 12, 2026 •
edited
Loading

Copy link
Copy Markdown

Backport to 9.0.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/9.0.x/7df5d80ff3a98714a1d3cdbe82941229e511f4b3/pr-14467

Backported as #14468

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback Bot mentioned this pull request May 12, 2026
Merged
nicoddemus pushed a commit that referenced this pull request May 23, 2026
docs: clarify subtests progress output (#14467) (#14468)
a86f3c3 
(cherry picked from commit 7df5d80)

Co-authored-by: 1Utkarsh1 <121078149+1Utkarsh1@users.noreply.github.com>
Co-authored-by: OpenAI Codex <codex@openai.com>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
nicoddemus nicoddemus approved these changes

Assignees

No one assigned

Labels

bot:chronographer:provided (automation) changelog entry is part of PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation shows incorrect pytest output color for subtests

3 participants

Back | FazBrowse Home | New Git URL