gh-117146: Expose/document warnings.WarningMessage #117147
Closed
Conversation
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
This comment was marked as spam.
This comment was marked as spam.
hugovk
reviewed
Mar 22, 2024
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Member
|
Reviewers: note that the discussion is still ongoing, it has not be agreed to expose the type (rather than just the interface of the object returned). |
Contributor
|
Thanks @merwok for adding the do not merge label. Additional discussion is in this Discourse thread: https://discuss.python.org/t/warningmessage-is-undocumented/48877/1 |
Member
|
I'm propose to close this one until the DPO thread has evolved (there are also conflicts). In addition, the attributes are already partly documented. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
gh-117146: Expose/document warnings.WarningMessage
This change exposes
warnings.WarningMessageas it is already returned by a public facing function:catch_warnings. Mention it in the docs and add it to__all__📚 Documentation preview 📚: https://cpython-previews--117147.org.readthedocs.build/