Document warnings.WarningMessage

[csm10495]

Documentation

Adding documentation for warnings.WarningMessage.

discuss thread: https://discuss.python.org/t/warningmessage-is-undocumented/48877/11

Linked PRs

• gh-117146: Expose/document warnings.WarningMessage #117147

[picnixz]

Marking as pending as this is still under discussion. NVM: the PR has a DO-NOT-MERGE label. I will close this issue until the discussion in DPO has been resolved. Note that is already partly documented:

If record is True, a list is returned that is progressively populated with objects as seen by a custom showwarning() function (which also suppresses output to sys.stdout). Each object in the list has attributes with the same names as the arguments to showwarning().