gh-139837: document attributes of objects recorded by warnings.catch_warnings#139893
gh-139837: document attributes of objects recorded by warnings.catch_warnings#139893Aniketsy wants to merge 9 commits into
Conversation
|
@StanFromIreland Please review these changes when you get a chance. |
|
This PR is stale because it has been open for 30 days with no activity. |
|
@vstinner, could you please review this PR? |
Documentation build overview
111 files changed ·
|
| - ``lineno``: the line number in the file (int) | ||
| - ``file``: the file object used for output (if any) | ||
| - ``line``: the line of source code (if available) | ||
| - ``source``: the original object that generated the warning (if available) |
There was a problem hiding this comment.
WarningMessage now also has a module attribute (None by default).
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Victor Stinner <vstinner@python.org>
|
@vstinner thanks for the review and suggestion, i've applied changes, please let me know if we need any further improvements. |
|
i think by updating branch, this ci fail will be green . |
github-actions
Bot
removed
the
stale
|
@vstinner gentle ping, in this also 😀 , i think we're ready for this also please let me know your thoughts. |
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
You have not added module.
ah sorry 😿 i missed . |
vstinner
left a comment
vstinner
left a comment
There was a problem hiding this comment.
LGTM. Maybe just reformat to fit into 80 columns.
| .. versionchanged:: 3.15 | ||
| The ``module`` attribute was added. | ||
|
|
||
| The type of these objects is not specified and may change; only the presence of these attributes is guaranteed. |
There was a problem hiding this comment.
You should truncate the paragraph to 80 columns. Same remark for the list of attributes above.
thanks, i've update the format to fit . |
4 participants
#139837
This PR updates the documentation for :func:warnings.catch_warnings:
Please let me know if my approach or fix needs any improvements . I’m open to feedback and happy to make changes based on suggestions.
Thankyou !
📚 Documentation preview 📚: https://cpython-previews--139893.org.readthedocs.build/