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

Add more examples in the warnings docs #93343

Open
ezio-melotti opened this issue May 30, 2022 · 6 comments
Open

Add more examples in the warnings docs #93343

ezio-melotti opened this issue May 30, 2022 · 6 comments
Labels
3.10 only security fixes 3.11 only security fixes 3.12 bugs and security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@ezio-melotti
Copy link
Member

ezio-melotti commented May 30, 2022

This is a follow-up of GH-86438 and GH-23172. The warnings docs should include more examples to show how to match different types of warnings using both the provided functions and -W/PYTHONWARNINGS, especially since they behave differently.

At the bottom of pytest-dev/pytest#8759 (comment) there are already some examples to illustrate some of the differences, even though some are specific to pytest.

Linked PRs

@ezio-melotti ezio-melotti added docs Documentation in the Doc dir 3.11 only security fixes 3.10 only security fixes 3.12 bugs and security fixes labels May 30, 2022
@ezio-melotti ezio-melotti added type-feature A feature request or enhancement easy labels Aug 6, 2022
@Jamesgo1
Copy link

Hi there, first time contributor here. I'd be happy to attempt this if that would be OK?

@hugovk
Copy link
Member

hugovk commented Dec 27, 2022

@Jamesgo1 Hi, that would be great, thanks!

See https://devguide.python.org for info about building docs and contributing PRs, and also feel free to ask here too.

@liam-gersten
Copy link
Contributor

Hello, my name is Liam, and I’m part of a student software engineer group of 4 at Carnegie Mellon. We’ve been tasked with contributing to an open source project, and this issue seems like a great first start. Would you mind assigning this to me (my group)? Also, you might see the same comment on 1-2 other issues, since we’ll likely be working on more than just one for our assignment.

@hugovk
Copy link
Member

hugovk commented Apr 18, 2023

Hi Liam and your group! Sounds great!

We don't usually assign issues, because sometimes people don't get around to making PRs for a wide variety of reasons, and we don't want others to think they've been pre-booked.

Instead, please go ahead with it, and don't hesitate to ask questions :)

daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 10, 2023
Add documentation for differences between programatic and environment filters
daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 11, 2023
Add examples of warning filters and the difference between programatic and environmental filters.
daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 11, 2023
Add examples of warning filters and the difference between programatic and environmental filters.
@daniel-shimon
Copy link

Hi @ezio-melotti !
I've made a PR with some new examples inspired from your link, can you take a look?

daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 12, 2023
    Add examples of warning filters and the difference between programatic and environmental filters.
daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 12, 2023
    Add examples of warning filters and the difference between programatic and environmental filters.
daniel-shimon added a commit to daniel-shimon/cpython that referenced this issue Jul 12, 2023
@vaishnavi192
Copy link
Contributor

vaishnavi192 commented Dec 22, 2023

@daniel-shimon is this issue still open to work on or you have created a PR so it's closed now? @hugovk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.10 only security fixes 3.11 only security fixes 3.12 bugs and security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement
Projects
None yet
Development

No branches or pull requests

6 participants