[issue38466] threading.excepthook doc talks about "object"
New submission from Sebastian Rittau <srittau@rittau.biz>: The documentation of threading.excepthook (https://docs.python.org/3.8/library/threading.html#threading.excepthook) talks about "object", when it only has a "thread" attribute: "Storing object using a custom hook can resurrect it if it is set to an object which is being finalized. Avoid storing object after the custom hook completes to avoid resurrecting objects." I believe this is a copy and paste error from sys.unraisablehook. ---------- assignee: docs@python components: Documentation messages: 354588 nosy: docs@python, srittau, vstinner priority: normal severity: normal status: open title: threading.excepthook doc talks about "object" versions: Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- keywords: +newcomer friendly title: threading.excepthook doc talks about "object" -> [Easy doc] threading.excepthook doc talks about "object" _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
Daniel Baskal <daniel.baskal@gmail.com> added the comment: Hi, as a newcomer I'd like to work on this! Though, I am uncertain about whether these two hooks (threading.excepthook and sys.unraisablehook) have similar behavior and wouldn't it be misleading to simply change mentions of "object" to "thread" in the docs? Thanks for the guidance! ---------- nosy: +Daniel Baskal _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
STINNER Victor <vstinner@python.org> added the comment:
https://docs.python.org/3.8/library/threading.html#threading.excepthook
"Storing *object* using a custom hook can resurrect it" should be "Storing *thread* using a custom hook can resurrect it" in Doc/library/threading.rst ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- keywords: +patch pull_requests: +16430 stage: -> patch review pull_request: https://github.com/python/cpython/pull/16891 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset 91528f40c30717563a478920861c81d18da5bf63 by Victor Stinner (Daniel Baskal) in branch 'master': bpo-38466: Fix threading.excepthook doc (GH-16891) https://github.com/python/cpython/commit/91528f40c30717563a478920861c81d18da... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +16433 pull_request: https://github.com/python/cpython/pull/16894 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 6329a56ca7f99075caa95a075024736a90ad2857 by Miss Skeleton (bot) in branch '3.8': bpo-38466: Fix threading.excepthook doc (GH-16891) https://github.com/python/cpython/commit/6329a56ca7f99075caa95a075024736a90a... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: Thanks Daniel Baskal for the fix and Sebastian Rittau for the bug report. The doc is now fixed in 3.8 and master branches. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38466> _______________________________________
participants (5)
-
Daniel Baskal -
miss-islington
-
Roundup Robot
-
Sebastian Rittau
-
STINNER Victor