Repository navigation
Idle extension configuration: add option-help option #66894
Description
| BPO | 22705 |
|---|---|
| Nosy | @terryjreedy |
| Files |
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 2014-10-23.00:17:13.468>
labels = ['expert-IDLE', 'type-feature', '3.8']
title = 'Idle extension configuration: add option-help option'
updated_at = <Date 2019-02-21.00:32:40.224>
user = 'https://github.com/terryjreedy'bugs.python.org fields:
activity = <Date 2019-02-21.00:32:40.224>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2014-10-23.00:17:13.468>
creator = 'terry.reedy'
dependencies = []
files = ['37012']
hgrepos = []
issue_num = 22705
keywords = ['patch']
message_count = 5.0
messages = ['229847', '229880', '229912', '229995', '336167']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'Saimadhav.Heblikar']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22705'
versions = ['Python 3.8']Metadata
Metadata
Assignees
Projects
- Status
Activity
terryjreedy commentedon Oct 23, 2014
bpo-3068 adds a extension configuration dialog, with some validation of user input. msg228890 suggest a new 'option-help' option to explain the meaning of options, limit int entries when appropriate, and limit string choices (with a drop-down list) when appropriate. The help could also indicate options that require a restart to take effect.
SaimadhavHeblikar commentedon Oct 23, 2014
Would like to check if a tooltip would be appropriate for this?
If yes, I would like to work on it.
terryjreedy commentedon Oct 24, 2014
I was originally thinking of displaying 'option-help' beside a read-only text widget containing the value, just under the enable key-value pairs. But I can imagine that tooltips attached to the label (on the left) might be a better alternative. This would avoid having half the text in the page being help text that would just be noise to someone who already knew what it says. It would also allow reformatting of data parsed from the option-help text. So go ahead and give it a try. I have lots else to do ;-).
I want to restore / add the [Help] button to both dialogs. For the main dialog, it could contain info about which options have a delayed effect (see bpo-22707). For extensions, it could display the raw option-help text and mention how to get tool tips.
ToolTip.py (and CallTipWindow.py, with an expanded version of the tooltip code), use a Toplevel with its window frame and title bar surpressed. An alternate way to get a popup box with a simple thin-line frameis a menu and its tk_popup method. I believe the command associated with each 'menu' item could just be "lambda: pass" to close the popup when clicked. (One thing not clear to me is why tooltip (and calltip) create a new Toplevel for each display rather than just changing the text of the widget it displays.)
SaimadhavHeblikar commentedon Oct 25, 2014
Attached is a patch which attempts to display help text using a ToolTip. The additional requirement is that for entry 'name', there be another entry have a 'name_help' in the config-extensions.def(easier to see the file to understand what I mean).
A few changes were required in ToolTip.py to adjust the delay in millisecond value.
Note : In the current patch, I have added demo help string only for CodeContext and AutoComplete.
terryjreedy commentedon Feb 21, 2019
bpo-27099 (converting built-in extensions to features) made this less important. But it is still relevant to actual extensions. There is a dummy extension, zzdummy, for testing.