Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove exceptiongroups from getting started page? #12883

Open
The-Compiler opened this issue Oct 13, 2024 · 2 comments
Open

Remove exceptiongroups from getting started page? #12883

The-Compiler opened this issue Oct 13, 2024 · 2 comments
Labels
type: docs documentation improvement, missing or needing clarification

Comments

@The-Compiler
Copy link
Member

Motivated by #12880, which proposes adding even more content to the "getting started with pytest" page, intended for teaching the very basics of pytest's functionality:

Personally I think exception groups shouldn't be on a page describing how to write your first test at all. It's not a feature new pytest (and potentially Python) users necessarily need to know about when just starting out. We don't even explain e.g. match= for pytest.raises on that page.

If we keep it, at the very least it shouldn't be between an example being shown, and that example being run later...:

image

But IMHO it has no place there at all, and the How to write and report assertions in tests page already has a very similar explanation, where it does seem to fit in well.

@lanzz @Zac-HD what do you think?

@The-Compiler The-Compiler added the type: docs documentation improvement, missing or needing clarification label Oct 13, 2024
@lanzz
Copy link
Contributor

lanzz commented Oct 13, 2024

I don't mind removing it from getting-started.rst, your reasoning is compelling and I might have gone a bit overboard in adding it there in the first place.

@Zac-HD
Copy link
Member

Zac-HD commented Oct 13, 2024

Sounds good to me - let's cut back to the first very simple example, and then just say e.g. "Assertions about expected exceptions explains how to match exception messages or the contents of ExceptionGroup." so that it's easy to find for anyone who knows they need that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

No branches or pull requests

3 participants