-
-
Notifications
You must be signed in to change notification settings - Fork 30k
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
warnings.catch_warnings: undocumented arguments (category, lineno, append) #123223
Comments
The |
Thanks for the follow up! I would also assume that they have the same meaning, but without any explicit mention this is only guesswork that leaves users with the fear of writing code based on some incorrect assumption. Also, arguably, users looking for a quick reference currently have to parse the whole document, which makes a lot of people waste time (and leaves them guessing anyway). Pointers to the semantics of these arguments would thus indeed be very useful! |
…123231) * Adding hyperlink of argument * Modify as reviewer suggested
Fixed in the attached merged PR |
…ngs: (pythonGH-123231) * Adding hyperlink of argument * Modify as reviewer suggested (cherry picked from commit 828583a) Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
…ngs: (pythonGH-123231) * Adding hyperlink of argument * Modify as reviewer suggested (cherry picked from commit 828583a) Co-authored-by: Damien <81557462+Damien-Chen@users.noreply.github.com>
Thanks for making explicit the semantics of Again, it would be nice if the semantics of |
Documentation
The documentation for warnings.catch_warnings (Python 3.12.5) does not describe what its
category
,lineno
andappend
arguments do.Documenting what these arguments do would arguably allow users to use them, or to use it in a more robust way (than by trial and error, and by making assumptions that may turn incorrect in the future).
Thanks!
Linked PRs
The text was updated successfully, but these errors were encountered: