classification
Title: IDLE: Show help(object) output in a text viewer
Type: enhancement Stage: patch review
Components: IDLE Versions: Python 3.9, Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: taleinat Nosy List: rhettinger, taleinat, terry.reedy
Priority: normal Keywords: patch

Created on 2019-08-05 20:56 by taleinat, last changed 2019-08-05 21:06 by taleinat.

Pull Requests
URL Status Linked Edit
PR 15140 open taleinat, 2019-08-05 21:03
Messages (3)
msg349073 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2019-08-05 20:56
Currently, IDLE just writes the entire help message into the shell.

If auto-squeezing is enabled, then long help messages are automatically squeezed, following which the help text can be viewed in a text viewer or expanded inline.  This is still not great UX.

I propose to simply have help(object) open a text viewer with the help text.  There's actually an old (2007) comment in Lib\idlelib\pyshell.py by KBK that this should be done.

See related discussion in issue #35855.
msg349075 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2019-08-05 21:04
See PR GH-15140.
msg349076 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2019-08-05 21:06
Raymond, I'm interested in your opinion on this.
History
Date User Action Args
2019-08-05 21:06:54taleinatsetnosy: + rhettinger
messages: + msg349076
2019-08-05 21:04:26taleinatsetmessages: + msg349075
2019-08-05 21:03:51taleinatsetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request14878
2019-08-05 20:56:06taleinatcreate