[Python-checkins] gh-89362: Doc IDLE menu and search (GH-95697) (GH-95718)
ambv
webhook-mailer at python.org
Sat Aug 6 13:01:16 EDT 2022
https://github.com/python/cpython/commit/11f7d41ccf369a6400fff9321955f17f5aa8d4ff
commit: 11f7d41ccf369a6400fff9321955f17f5aa8d4ff
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2022-08-06T19:01:10+02:00
summary:
gh-89362: Doc IDLE menu and search (GH-95697) (GH-95718)
Update menu item position and capitalization.
Add paragraph about search.
For help.html, include save-as addition.
(cherry picked from commit 834064c19a110dad425dc290c91c0545eaa24471)
Co-authored-by: Terry Jan Reedy <tjreedy at udel.edu>
files:
M Doc/library/idle.rst
M Lib/idlelib/help.html
diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst
index 2d52e5355749..f2ef72d682bd 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 <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 <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 e8e7d2876097..ac386122cc71 100644
--- a/Lib/idlelib/help.html
+++ b/Lib/idlelib/help.html
@@ -91,6 +91,7 @@ <h3><a href="../contents.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#editor-windows">Editor windows</a></li>
<li><a class="reference internal" href="#key-bindings">Key bindings</a></li>
<li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li>
+<li><a class="reference internal" href="#search-and-replace">Search and Replace</a></li>
<li><a class="reference internal" href="#completions">Completions</a></li>
<li><a class="reference internal" href="#calltips">Calltips</a></li>
<li><a class="reference internal" href="#code-context">Code Context</a></li>
@@ -237,13 +238,13 @@ <h3>File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and
</dd>
<dt>Open…</dt><dd><p>Open an existing file with an Open dialog.</p>
</dd>
-<dt>Recent Files</dt><dd><p>Open a list of recent files. Click one to open it.</p>
-</dd>
<dt>Open Module…</dt><dd><p>Open an existing module (searches sys.path).</p>
</dd>
+<dt>Recent Files</dt><dd><p>Open a list of recent files. Click one to open it.</p>
+</dd>
</dl>
<dl class="simple" id="index-1">
-<dt>Class Browser</dt><dd><p>Show functions, classes, and methods in the current Editor file in a
+<dt>Module Browser</dt><dd><p>Show functions, classes, and methods in the current Editor file in a
tree structure. In the shell, open a module first.</p>
</dd>
<dt>Path Browser</dt><dd><p>Show sys.path directories, modules, functions, classes and methods in a
@@ -255,10 +256,13 @@ <h3>File menu (Shell and Editor)<a class="headerlink" href="#file-menu-shell-and
do Save As instead.</p>
</dd>
<dt>Save As…</dt><dd><p>Save the current window with a Save As dialog. The file saved becomes the
-new associated file for the window.</p>
+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.)</p>
</dd>
<dt>Save Copy As…</dt><dd><p>Save the current window to different file without changing the associated
-file.</p>
+file. (See Save As note above about filename extensions.)</p>
</dd>
<dt>Print Window</dt><dd><p>Print the current window to the default printer.</p>
</dd>
@@ -278,6 +282,8 @@ <h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and
</dd>
<dt>Redo</dt><dd><p>Redo the last undone change to the current window.</p>
</dd>
+<dt>Select All</dt><dd><p>Select the entire contents of the current window.</p>
+</dd>
<dt>Cut</dt><dd><p>Copy selection into the system-wide clipboard; then delete the selection.</p>
</dd>
<dt>Copy</dt><dd><p>Copy selection into the system-wide clipboard.</p>
@@ -287,8 +293,6 @@ <h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and
</dl>
<p>The clipboard functions are also available in context menus.</p>
<dl class="simple">
-<dt>Select All</dt><dd><p>Select the entire contents of the current window.</p>
-</dd>
<dt>Find…</dt><dd><p>Open a search dialog with many options</p>
</dd>
<dt>Find Again</dt><dd><p>Repeat the last search, if there is one.</p>
@@ -309,17 +313,21 @@ <h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and
<dt>Expand Word</dt><dd><p>Expand a prefix you have typed to match a full word in the same window;
repeat to get a different expansion.</p>
</dd>
-<dt>Show call tip</dt><dd><p>After an unclosed parenthesis for a function, open a small window with
+<dt>Show Call Tip</dt><dd><p>After an unclosed parenthesis for a function, open a small window with
function parameter hints. See <a class="reference internal" href="#calltips"><span class="std std-ref">Calltips</span></a> in the
Editing and navigation section below.</p>
</dd>
-<dt>Show surrounding parens</dt><dd><p>Highlight the surrounding parenthesis.</p>
+<dt>Show Surrounding Parens</dt><dd><p>Highlight the surrounding parenthesis.</p>
</dd>
</dl>
</section>
<section id="format-menu-editor-window-only">
<span id="format-menu"></span><h3>Format menu (Editor window only)<a class="headerlink" href="#format-menu-editor-window-only" title="Permalink to this heading">¶</a></h3>
<dl class="simple">
+<dt>Format Paragraph</dt><dd><p>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.</p>
+</dd>
<dt>Indent Region</dt><dd><p>Shift selected lines right by the indent width (default 4 spaces).</p>
</dd>
<dt>Dedent Region</dt><dd><p>Shift selected lines left by the indent width (default 4 spaces).</p>
@@ -338,11 +346,7 @@ <h3>Edit menu (Shell and Editor)<a class="headerlink" href="#edit-menu-shell-and
<dt>New Indent Width</dt><dd><p>Open a dialog to change indent width. The accepted default by the Python
community is 4 spaces.</p>
</dd>
-<dt>Format Paragraph</dt><dd><p>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.</p>
-</dd>
-<dt>Strip trailing whitespace</dt><dd><p>Remove trailing space and other whitespace characters after the last
+<dt>Strip Trailing Chitespace</dt><dd><p>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.</p>
@@ -565,6 +569,13 @@ <h3>Automatic indentation<a class="headerlink" href="#automatic-indentation" tit
<p>See also the indent/dedent region commands on the
<a class="reference internal" href="#format-menu"><span class="std std-ref">Format menu</span></a>.</p>
</section>
+<section id="search-and-replace">
+<h3>Search and Replace<a class="headerlink" href="#search-and-replace" title="Permalink to this heading">¶</a></h3>
+<p>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 <code class="docutils literal notranslate"><span class="pre">[x]</span> <span class="pre">Regular</span> <span class="pre">expresion</span></code> is checked, the
+target is interpreted according to the Python re module.</p>
+</section>
<section id="completions">
<span id="id3"></span><h3>Completions<a class="headerlink" href="#completions" title="Permalink to this heading">¶</a></h3>
<p>Completions are supplied, when requested and available, for module
@@ -1021,6 +1032,7 @@ <h3><a href="../contents.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#editor-windows">Editor windows</a></li>
<li><a class="reference internal" href="#key-bindings">Key bindings</a></li>
<li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li>
+<li><a class="reference internal" href="#search-and-replace">Search and Replace</a></li>
<li><a class="reference internal" href="#completions">Completions</a></li>
<li><a class="reference internal" href="#calltips">Calltips</a></li>
<li><a class="reference internal" href="#code-context">Code Context</a></li>
@@ -1141,7 +1153,7 @@ <h3>Navigation</h3>
<br />
<br />
- Last updated on Jul 03, 2022.
+ Last updated on Aug 05, 2022.
<a href="/bugs.html">Found a bug</a>?
<br />
More information about the Python-checkins
mailing list