This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: help('signal') incomplete (e.g: signal.signal not visible)
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Gabriel Pettier (Tshirtman), docs@python, ethan.furman, giampaolo.rodola, miss-islington, nanjekyejoannah, r.david.murray, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2016-08-09 12:41 by Gabriel Pettier (Tshirtman), last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 30063 merged serhiy.storchaka, 2021-12-11 21:17
PR 30080 merged serhiy.storchaka, 2021-12-13 09:38
PR 30084 merged miss-islington, 2021-12-13 10:15
Messages (6)
msg272240 - (view) Author: Gabriel Pettier (Tshirtman) (Gabriel Pettier (Tshirtman)) Date: 2016-08-09 12:41
Up to apparently python 3.5, using help('signal') used to show the 'signal.signal' function among others, now it's not in the list, while of course help('signal.signal') does work, it was reported to me to still be the case in 3.6a1.
msg272248 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2016-08-09 13:47
The conversion of the module from a pure python module to a mixed module apparently caused a number of changes to the pydoc output.  This should be addressed to make the pydoc output complete, even if it still different in detail.
msg408342 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2021-12-11 21:21
This is due to use functools.wraps(). If __all__ is not defined all non-builtin functions should have correct __module__ to be displayed by pydoc. functools.wraps() assigns __module__, __name__, __qualname__, __doc__ and __annotations__. __module__ should be preserved ('signal', not '_signal'), __name__ and __qualname__ are already correct, __annotations__ does not exist. So only __doc__ should be copied.
msg408430 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2021-12-13 09:21
New changeset e08c0d8eec528f1d7a282ee19bcadb9aae9ec123 by Serhiy Storchaka in branch 'main':
bpo-27718: Fix help for the signal module (GH-30063)
msg408436 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2021-12-13 10:15
New changeset e55deaabd8de338138cf29aea6890996e794c997 by Serhiy Storchaka in branch '3.10':
[3.10] bpo-27718: Fix help for the signal module (GH-30063) (GH-30080)
msg408438 - (view) Author: miss-islington (miss-islington) Date: 2021-12-13 10:43
New changeset 80f98b1614cc8e58d8a5ec72c94d27f663e23035 by Miss Islington (bot) in branch '3.9':
[3.10] bpo-27718: Fix help for the signal module (GH-30063) (GH-30080)
Date User Action Args
2022-04-11 14:58:34adminsetgithub: 71905
2021-12-13 11:12:53serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-12-13 10:43:39miss-islingtonsetmessages: + msg408438
2021-12-13 10:15:13serhiy.storchakasetmessages: + msg408436
2021-12-13 10:15:06miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request28305
2021-12-13 09:38:18serhiy.storchakasetpull_requests: + pull_request28301
2021-12-13 09:21:59serhiy.storchakasetmessages: + msg408430
2021-12-11 21:21:33serhiy.storchakasetmessages: + msg408342
2021-12-11 21:17:21serhiy.storchakasetkeywords: + patch
nosy: + serhiy.storchaka

pull_requests: + pull_request28283
stage: patch review
2021-12-11 18:39:08iritkatrielsetversions: + Python 3.9, Python 3.10, Python 3.11, - Python 3.5, Python 3.6
2019-09-09 02:51:21nanjekyejoannahsetnosy: + nanjekyejoannah
2016-08-09 13:47:09r.david.murraysetnosy: + r.david.murray
messages: + msg272248
2016-08-09 13:33:07serhiy.storchakasetnosy: + giampaolo.rodola, ethan.furman
2016-08-09 12:41:19Gabriel Pettier (Tshirtman)create