[Python-checkins] bpo-35097: Add IDLE doc subsection explaining editor windows. (GH-10206)

Miss Islington (bot) webhook-mailer at python.org
Sun Oct 28 21:51:48 EDT 2018


https://github.com/python/cpython/commit/9bdadc163f306ddb4659c6732ea24401957488db
commit: 9bdadc163f306ddb4659c6732ea24401957488db
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-10-28T18:51:45-07:00
summary:

bpo-35097: Add IDLE doc subsection explaining editor windows. (GH-10206)


Topics include opening, title and status bar, .py* extension, and running.
(cherry picked from commit ea9c8bd44365ae8b0accc5286c7b52862528c0ec)

Co-authored-by: Terry Jan Reedy <tjreedy at udel.edu>

files:
A Misc/NEWS.d/next/IDLE/2018-10-28-20-17-14.bpo-35097.07tm66.rst
M Doc/library/idle.rst
M Lib/idlelib/help.html

diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst
index 3bf87c25a8d5..0826d99b6336 100644
--- a/Doc/library/idle.rst
+++ b/Doc/library/idle.rst
@@ -358,6 +358,24 @@ Squeeze
 Editing and navigation
 ----------------------
 
+Editor windows
+^^^^^^^^^^^^^^
+
+IDLE may open editor windows when it starts, depending on settings
+and how you start IDLE.  Thereafter, use the File menu.  There can be only
+one open editor window for a given file.
+
+The title bar contains the name of the file, the full path, and the version
+of Python and IDLE running the window.  The status bar contains the line
+number ('Ln') and column number ('Col').  Line numbers start with 1;
+column numbers with 0.
+
+IDLE assumes that files with a known .py* extension contain Python code
+and that other files do not.  Run Python code with the Run menu.
+
+Key bindings
+^^^^^^^^^^^^
+
 In this section, 'C' refers to the :kbd:`Control` key on Windows and Unix and
 the :kbd:`Command` key on Mac OSX.
 
@@ -397,7 +415,6 @@ the :kbd:`Command` key on Mac OSX.
 Standard keybindings (like :kbd:`C-c` to copy and :kbd:`C-v` to paste)
 may work.  Keybindings are selected in the Configure IDLE dialog.
 
-
 Automatic indentation
 ^^^^^^^^^^^^^^^^^^^^^
 
diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html
index b8fecce0c9a2..24fd77da904e 100644
--- a/Lib/idlelib/help.html
+++ b/Lib/idlelib/help.html
@@ -381,6 +381,20 @@ <h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and
 </div>
 <div class="section" id="editing-and-navigation">
 <h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="editor-windows">
+<h3>Editor windows<a class="headerlink" href="#editor-windows" title="Permalink to this headline">¶</a></h3>
+<p>IDLE may open editor windows when it starts, depending on settings
+and how you start IDLE.  Thereafter, use the File menu.  There can be only
+one open editor window for a given file.</p>
+<p>The title bar contains the name of the file, the full path, and the version
+of Python and IDLE running the window.  The status bar contains the line
+number (‘Ln’) and column number (‘Col’).  Line numbers start with 1;
+column numbers with 0.</p>
+<p>IDLE assumes that files with a known .py* extension contain Python code
+and that other files do not.  Run Python code with the Run menu.</p>
+</div>
+<div class="section" id="key-bindings">
+<h3>Key bindings<a class="headerlink" href="#key-bindings" title="Permalink to this headline">¶</a></h3>
 <p>In this section, ‘C’ refers to the <kbd class="kbd docutils literal notranslate">Control</kbd> key on Windows and Unix and
 the <kbd class="kbd docutils literal notranslate">Command</kbd> key on Mac OSX.</p>
 <ul>
@@ -416,6 +430,7 @@ <h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" t
 </ul>
 <p>Standard keybindings (like <kbd class="kbd docutils literal notranslate">C-c</kbd> to copy and <kbd class="kbd docutils literal notranslate">C-v</kbd> to paste)
 may work.  Keybindings are selected in the Configure IDLE dialog.</p>
+</div>
 <div class="section" id="automatic-indentation">
 <h3>Automatic indentation<a class="headerlink" href="#automatic-indentation" title="Permalink to this headline">¶</a></h3>
 <p>After a block-opening statement, the next line is indented by 4 spaces (in the
@@ -725,6 +740,8 @@ <h3><a href="../contents.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li><a class="reference internal" href="#editing-and-navigation">Editing and navigation</a><ul>
+<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="#completions">Completions</a></li>
 <li><a class="reference internal" href="#calltips">Calltips</a></li>
diff --git a/Misc/NEWS.d/next/IDLE/2018-10-28-20-17-14.bpo-35097.07tm66.rst b/Misc/NEWS.d/next/IDLE/2018-10-28-20-17-14.bpo-35097.07tm66.rst
new file mode 100644
index 000000000000..a1e58ee5983c
--- /dev/null
+++ b/Misc/NEWS.d/next/IDLE/2018-10-28-20-17-14.bpo-35097.07tm66.rst
@@ -0,0 +1,2 @@
+Add IDLE doc subsection explaining editor windows. Topics include opening,
+title and status bar, .py* extension, and running.



More information about the Python-checkins mailing list