IDLE: Implement or delete python-context-help.

[terryjreedy]

BPO	44574
Nosy	@terryjreedy

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/terryjreedy'
closed_at = None
created_at = <Date 2021-07-07.03:01:22.979>
labels = ['expert-IDLE', '3.11']
title = 'IDLE: Implement or delete python-context-help.'
updated_at = <Date 2021-07-07.03:06:01.299>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2021-07-07.03:06:01.299>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2021-07-07.03:01:22.979>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 44574
keywords = []
message_count = 2.0
messages = ['397058', '397059']
nosy_count = 1.0
nosy_names = ['terry.reedy']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue44574'
versions = ['Python 3.11']

[terryjreedy]

The config.IdleConf.GetCoreKeys keyBindings dict contains
'<<python-context-help>>': ['<Shift-F1>']
The was included in the initial version by Steven Gava, 9930061, on 2001 Dec 2. So it appears in the Keys page of the config dialog, as noticed by Mondher on SO ((https://stackoverflow.com/questions/68263769/idle-shell-context-documentation-broken)

The string does not appear elsewhere in idlelib, nor is the feature mentioned in the IDLE doc. So it is unimplemented and undocumented. Based on experience with other IDEs (Mathematica) Mondher suggests that one should be able to select a word and have it looked up in the index of the document opened by python-doc F1. 'Very useful' he says.

On Windows, F1 opens an offline Windows help window with the Python docs. Currently, modifier(s)-F1 is interpreted as F1 and the help window is opened. I presume a shift-F1 binding will override that. I also presume that an argument can be added to the Windows open-help command.

I don't know about online docs on other systems and don't think we can access indexes on opened python webpages. Where shift-F1 does not work, a message should be displayed.

If we decided to not implement index search anywhere, the line in config.py should be removed.

[terryjreedy]

I should check whether all other keybindings are implemented.