[issue39913] Document warnings.WarningMessage ?
New submission from daniel hahler <python-bugs@thequod.de>: I've noticed that `warnings.WarningMessage` is not documented, i.e. it does not show up in the intersphinx object list. I'm not sure how to document it best, but maybe just describing its attributes? Ref: https://github.com/blueyed/cpython/blob/598d29c51c7b5a77f71eed0f615eb0b3865a... ---------- assignee: docs@python components: Documentation messages: 363735 nosy: blueyed, docs@python priority: normal severity: normal status: open title: Document warnings.WarningMessage ? _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39913> _______________________________________
Rémi Lapeyre <remi.lapeyre@henki.fr> added the comment: warnings.WarningMessage was added in https://bugs.python.org/issue26568 at the same time than _showwarnmsg_impl() and _formatwarnmsg_impl(). The goal was to have public functions that took them instead of multiple arguments so it could be easily extended in the future. It looks like it never happened and as of today there is no way to use warnings.WarningMessage in user code. Maybe it is time to bikeshed the names and add them? ---------- nosy: +remi.lapeyre, vstinner _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39913> _______________________________________
participants (2)
-
daniel hahler -
Rémi Lapeyre