Skip to content

docs: clarify reportinfo() return tuple in non-python example#14256

Merged
nicoddemus merged 1 commit intopytest-dev:mainfrom
mitre88:patch-1
Mar 6, 2026
Merged

docs: clarify reportinfo() return tuple in non-python example#14256
nicoddemus merged 1 commit intopytest-dev:mainfrom
mitre88:patch-1

Conversation

@mitre88
Copy link
Contributor

@mitre88 mitre88 commented Mar 5, 2026

Summary

  • Clarify the expected return value of reportinfo() in the non-Python collection example.
  • Document the tuple structure as (path, lineno, description).
  • Explain each element (path, zero-based lineno, and description) in plain language.

Closes #6689

Notes

  • Documentation-only change; no runtime behavior changed.
  • Tests are not required for this docs clarification.

@mitre88
Update documentation for reportinfo() return values
6c25d3b 
Clarify the return value of reportinfo() in verbose mode.
nicoddemus
nicoddemus approved these changes Mar 6, 2026
View reviewed changes
Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

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

Thanks!

@nicoddemus nicoddemus added skip news used on prs to opt out of the changelog requirement backport 9.0.x apply to PRs at any point; backports the changes to the 9.0.x branch labels Mar 6, 2026
@nicoddemus nicoddemus merged commit 8638c7d into pytest-dev:main Mar 6, 2026
33 checks passed
@patchback
Copy link

patchback bot commented Mar 6, 2026 •
edited
Loading

Backport to 9.0.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/9.0.x/8638c7d3f214c0e0e2f8578280cd6f8765a5771c/pr-14256

Backported as #14265

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

patchback bot pushed a commit that referenced this pull request Mar 6, 2026
@mitre88 @patchback
Update documentation for reportinfo() return values (#14256)
1755f1d 
Clarify the return value of reportinfo() in verbose mode.

(cherry picked from commit 8638c7d)
@patchback patchback bot mentioned this pull request Mar 6, 2026
Merged
nicoddemus pushed a commit that referenced this pull request Mar 6, 2026
@patchback @mitre88
Update documentation for reportinfo() return values (#14256) (#14265)
8ed11b2 
Clarify the return value of reportinfo() in verbose mode.

(cherry picked from commit 8638c7d)

Co-authored-by: Dr Alex Mitre <bedr10_capacitacion@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nicoddemus nicoddemus nicoddemus approved these changes

Assignees

No one assigned

Labels

backport 9.0.x apply to PRs at any point; backports the changes to the 9.0.x branch skip news used on prs to opt out of the changelog requirement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Item.reportinfo is missing documentation

2 participants

@mitre88 @nicoddemus