bpo-37765: Add keywords to IDLE tab completions #15138
Conversation
|
When you're done making the requested changes, leave the comment: |
|
Cheryl, please review again, including the rewritten Completions section. |
Doc/library/idle.rst
Outdated
| adding and deleting characters, with Up, Down, Page Up, Page Down, Home | ||
| and End keys, and by a single click within the box. Keys <Escape>, |
There was a problem hiding this comment.
Here you mention keys without enclosing them in brackets, but in the next line you enclose the keys in brackets. You also use the :kbd: directive below. Was there a reason for using different styles?
There was a problem hiding this comment.
I was consistent within sentences ;-). Habit and history. The directive translates to <kbd class="kbd docutils literal notranslate">Backspace</kbd>. In my Firefox, this displays a slightly bold sans serif. The contrast with normal text depends on whether normal text has serifs or not, and with styling turned on, it does not. In help.py, the kbd tag is not translated, so no contrast. We should revise that to 'em' (currently italics) or a new tk 'bd' tag.
Doc/library/idle.rst
Outdated
| being completed and the item highlighted in the box can be changed by | ||
| adding and deleting characters, with Up, Down, Page Up, Page Down, Home | ||
| and End keys, and by a single click within the box. Keys <Escape>, | ||
| <Enter>, and double <Tab> and clicks outside the box close the box. |
There was a problem hiding this comment.
I think 'close the box' is the point of this sentence, but it gets lost. It might be clearer to start with that. Or, alternatively, to reformat this paragraph somehow as a navigation section with bullets or subsections. Something like
Open the completion list:
Get new completions:
Select a completion:
Close the box:
There was a problem hiding this comment.
I revised to "Close the box with ...", parallel to previous sentence. As to structure, we have a 3 dimensions: Open method (wait, hot key, tab), namespace (main, attribute, files), and stage (open select, close), with some cells blank (wait never opens the main namespace) and some entries identical. The existing order made little sense to me. I started with select and close because these are common to all open methods and lists. I made this more explicit. I follow with the 3 invocation methods and module level completions.
In any case, there are more edits all through the doc and a will wait a day for more comments before merging.
|
The functionality works as designed. I agree with Tal that having some missing keywords (like |
Co-authored-by: Cheryl Sabella <[email protected]>
Co-authored-by: Cheryl Sabella <[email protected]>
|
Thanks @terryjreedy for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9. |
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]> (cherry picked from commit bce2eb4) Co-authored-by: Terry Jan Reedy <[email protected]>
|
GH-21423 is a backport of this pull request to the 3.9 branch. |
|
GH-21424 is a backport of this pull request to the 3.8 branch. |
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]> (cherry picked from commit bce2eb4) Co-authored-by: Terry Jan Reedy <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]> (cherry picked from commit bce2eb4) Co-authored-by: Terry Jan Reedy <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]> (cherry picked from commit bce2eb4) Co-authored-by: Terry Jan Reedy <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key. Rewrite Completions doc. Co-authored-by: Cheryl Sabella <[email protected]>
Keywords are present in the main module tab completion lists generated by rlcompleter, which is used by REPLs on *nix. Add all keywords to to IDLE's main module name list except those already added from builtins (True, False, and None) . This list may also be used by Show Completions on the Edit menu, and its hot key.
Rewrite Completions doc.
https://bugs.python.org/issue37765