From 834064c19a110dad425dc290c91c0545eaa24471 Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Fri, 5 Aug 2022 12:21:45 -0400 Subject: gh-89362: Doc IDLE menu and search (#95697) Update menu item position and capitalization. Add paragraph about search. For help.html, include save-as addition. --- Doc/library/idle.rst | 42 +++++++++++++++++++++++++----------------- Lib/idlelib/help.html | 42 +++++++++++++++++++++++++++--------------- 2 files changed, 52 insertions(+), 32 deletions(-) diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index 2d52e53..f2ef72d 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -61,17 +61,17 @@ New File Open... Open an existing file with an Open dialog. -Recent Files - Open a list of recent files. Click one to open it. - Open Module... Open an existing module (searches sys.path). +Recent Files + Open a list of recent files. Click one to open it. + .. index:: - single: Class browser + single: Module browser single: Path browser -Class Browser +Module Browser Show functions, classes, and methods in the current Editor file in a tree structure. In the shell, open a module first. @@ -89,7 +89,7 @@ Save As... Save the current window with a Save As dialog. The file saved becomes the new associated file for the window. (If your file namager is set to hide extensions, the current extension will be omitted in the file name box. - If the new filename has no '.', '.py' and .'txt' will be added for Python + If the new filename has no '.', '.py' and '.txt' will be added for Python and text files, except that on macOS Aqua,'.py' is added for all files.) Save Copy As... @@ -117,6 +117,9 @@ Undo Redo Redo the last undone change to the current window. +Select All + Select the entire contents of the current window. + Cut Copy selection into the system-wide clipboard; then delete the selection. @@ -128,9 +131,6 @@ Paste The clipboard functions are also available in context menus. -Select All - Select the entire contents of the current window. - Find... Open a search dialog with many options @@ -159,12 +159,12 @@ Expand Word Expand a prefix you have typed to match a full word in the same window; repeat to get a different expansion. -Show call tip +Show Call Tip After an unclosed parenthesis for a function, open a small window with function parameter hints. See :ref:`Calltips ` in the Editing and navigation section below. -Show surrounding parens +Show Surrounding Parens Highlight the surrounding parenthesis. .. _format-menu: @@ -172,6 +172,11 @@ Show surrounding parens Format menu (Editor window only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Format Paragraph + Reformat the current blank-line-delimited paragraph in comment block or + multiline string or selected line in a string. All lines in the + paragraph will be formatted to less than N columns, where N defaults to 72. + Indent Region Shift selected lines right by the indent width (default 4 spaces). @@ -198,12 +203,7 @@ New Indent Width Open a dialog to change indent width. The accepted default by the Python community is 4 spaces. -Format Paragraph - Reformat the current blank-line-delimited paragraph in comment block or - multiline string or selected line in a string. All lines in the - paragraph will be formatted to less than N columns, where N defaults to 72. - -Strip trailing whitespace +Strip Trailing Chitespace Remove trailing space and other whitespace characters after the last non-whitespace character of a line by applying str.rstrip to each line, including lines within multiline strings. Except for Shell windows, @@ -474,6 +474,14 @@ are restricted to four spaces due to Tcl/Tk limitations. See also the indent/dedent region commands on the :ref:`Format menu `. +Search and Replace +^^^^^^^^^^^^^^^^^^ + +Any selection becomes a search target. However, only selections within +a line work because searches are only performed within lines with the +terminal newline removed. If ``[x] Regular expresion`` is checked, the +target is interpreted according to the Python re module. + .. _completions: Completions diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html index e8e7d28..ac38612 100644 --- a/Lib/idlelib/help.html +++ b/Lib/idlelib/help.html @@ -91,6 +91,7 @@
  • Editor windows
  • Key bindings
  • Automatic indentation
    • +
  • Search and Replace
  • Completions
  • Calltips
  • Code Context
    • @@ -237,13 +238,13 @@ described below are moved around to conform to Apple guidelines.

    Open…

    Open an existing file with an Open dialog.

    -
    Recent Files

    Open a list of recent files. Click one to open it.

    -
    Open Module…

    Open an existing module (searches sys.path).

    +
    Recent Files

    Open a list of recent files. Click one to open it.

    +
    -
    Class Browser

    Show functions, classes, and methods in the current Editor file in a +

    Module Browser

    Show functions, classes, and methods in the current Editor file in a tree structure. In the shell, open a module first.

    Path Browser

    Show sys.path directories, modules, functions, classes and methods in a @@ -255,10 +256,13 @@ and after the window title. If there is no associated file, do Save As instead.

    Save As…

    Save the current window with a Save As dialog. The file saved becomes the -new associated file for the window.

    +new associated file for the window. (If your file namager is set to hide +extensions, the current extension will be omitted in the file name box. +If the new filename has no ‘.’, ‘.py’ and ‘.txt’ will be added for Python +and text files, except that on macOS Aqua,’.py’ is added for all files.)

    Save Copy As…

    Save the current window to different file without changing the associated -file.

    +file. (See Save As note above about filename extensions.)

    Print Window

    Print the current window to the default printer.

    @@ -278,6 +282,8 @@ be undone.

    Redo

    Redo the last undone change to the current window.

    +
    Select All

    Select the entire contents of the current window.

    +
    Cut

    Copy selection into the system-wide clipboard; then delete the selection.

    Copy

    Copy selection into the system-wide clipboard.

    @@ -287,8 +293,6 @@ be undone.

    The clipboard functions are also available in context menus.

    -
    Select All

    Select the entire contents of the current window.

    -
    Find…

    Open a search dialog with many options

    Find Again

    Repeat the last search, if there is one.

    @@ -309,17 +313,21 @@ Clear any selection and update the line and column status.

    Expand Word

    Expand a prefix you have typed to match a full word in the same window; repeat to get a different expansion.

    -
    Show call tip

    After an unclosed parenthesis for a function, open a small window with +

    Show Call Tip

    After an unclosed parenthesis for a function, open a small window with function parameter hints. See Calltips in the Editing and navigation section below.

    -
    Show surrounding parens

    Highlight the surrounding parenthesis.

    +
    Show Surrounding Parens

    Highlight the surrounding parenthesis.

    Format menu (Editor window only)

    +
    Format Paragraph

    Reformat the current blank-line-delimited paragraph in comment block or +multiline string or selected line in a string. All lines in the +paragraph will be formatted to less than N columns, where N defaults to 72.

    +
    Indent Region

    Shift selected lines right by the indent width (default 4 spaces).

    Dedent Region

    Shift selected lines left by the indent width (default 4 spaces).

    @@ -338,11 +346,7 @@ Editing and navigation section below.

    New Indent Width

    Open a dialog to change indent width. The accepted default by the Python community is 4 spaces.

    -
    Format Paragraph

    Reformat the current blank-line-delimited paragraph in comment block or -multiline string or selected line in a string. All lines in the -paragraph will be formatted to less than N columns, where N defaults to 72.

    -
    -
    Strip trailing whitespace

    Remove trailing space and other whitespace characters after the last +

    Strip Trailing Chitespace

    Remove trailing space and other whitespace characters after the last non-whitespace character of a line by applying str.rstrip to each line, including lines within multiline strings. Except for Shell windows, remove extra newlines at the end of the file.

    @@ -565,6 +569,13 @@ are restricted to four spaces due to Tcl/Tk limitations.

    See also the indent/dedent region commands on the Format menu.

    +
    +

    Search and Replace

    +

    Any selection becomes a search target. However, only selections within +a line work because searches are only performed within lines with the +terminal newline removed. If [x] Regular expresion is checked, the +target is interpreted according to the Python re module.

    +

    Completions

    Completions are supplied, when requested and available, for module @@ -1021,6 +1032,7 @@ also used for testing.

  • Editor windows
  • Key bindings
  • Automatic indentation
    • +
  • Search and Replace
  • Completions
  • Calltips
  • Code Context
    • @@ -1141,7 +1153,7 @@ also used for testing.



    - Last updated on Jul 03, 2022. + Last updated on Aug 05, 2022. Found a bug?
    -- cgit v0.12