Skip to content

Commit ea9c8bd

Browse files
authored
bpo-35097: Add IDLE doc subsection explaining editor windows. (python#10206)
Topics include opening, title and status bar, .py* extension, and running.
1 parent c61e229 commit ea9c8bd

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed

Doc/library/idle.rst

+18-1
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,24 @@ Squeeze
358358
Editing and navigation
359359
----------------------
360360

361+
Editor windows
362+
^^^^^^^^^^^^^^
363+
364+
IDLE may open editor windows when it starts, depending on settings
365+
and how you start IDLE. Thereafter, use the File menu. There can be only
366+
one open editor window for a given file.
367+
368+
The title bar contains the name of the file, the full path, and the version
369+
of Python and IDLE running the window. The status bar contains the line
370+
number ('Ln') and column number ('Col'). Line numbers start with 1;
371+
column numbers with 0.
372+
373+
IDLE assumes that files with a known .py* extension contain Python code
374+
and that other files do not. Run Python code with the Run menu.
375+
376+
Key bindings
377+
^^^^^^^^^^^^
378+
361379
In this section, 'C' refers to the :kbd:`Control` key on Windows and Unix and
362380
the :kbd:`Command` key on Mac OSX.
363381

@@ -397,7 +415,6 @@ the :kbd:`Command` key on Mac OSX.
397415
Standard keybindings (like :kbd:`C-c` to copy and :kbd:`C-v` to paste)
398416
may work. Keybindings are selected in the Configure IDLE dialog.
399417

400-
401418
Automatic indentation
402419
^^^^^^^^^^^^^^^^^^^^^
403420

Lib/idlelib/help.html

+17
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,20 @@ <h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and
381381
</div>
382382
<div class="section" id="editing-and-navigation">
383383
<h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" title="Permalink to this headline"></a></h2>
384+
<div class="section" id="editor-windows">
385+
<h3>Editor windows<a class="headerlink" href="#editor-windows" title="Permalink to this headline"></a></h3>
386+
<p>IDLE may open editor windows when it starts, depending on settings
387+
and how you start IDLE. Thereafter, use the File menu. There can be only
388+
one open editor window for a given file.</p>
389+
<p>The title bar contains the name of the file, the full path, and the version
390+
of Python and IDLE running the window. The status bar contains the line
391+
number (‘Ln’) and column number (‘Col’). Line numbers start with 1;
392+
column numbers with 0.</p>
393+
<p>IDLE assumes that files with a known .py* extension contain Python code
394+
and that other files do not. Run Python code with the Run menu.</p>
395+
</div>
396+
<div class="section" id="key-bindings">
397+
<h3>Key bindings<a class="headerlink" href="#key-bindings" title="Permalink to this headline"></a></h3>
384398
<p>In this section, ‘C’ refers to the <kbd class="kbd docutils literal notranslate">Control</kbd> key on Windows and Unix and
385399
the <kbd class="kbd docutils literal notranslate">Command</kbd> key on Mac OSX.</p>
386400
<ul>
@@ -416,6 +430,7 @@ <h2>Editing and navigation<a class="headerlink" href="#editing-and-navigation" t
416430
</ul>
417431
<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)
418432
may work. Keybindings are selected in the Configure IDLE dialog.</p>
433+
</div>
419434
<div class="section" id="automatic-indentation">
420435
<h3>Automatic indentation<a class="headerlink" href="#automatic-indentation" title="Permalink to this headline"></a></h3>
421436
<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>
725740
</ul>
726741
</li>
727742
<li><a class="reference internal" href="#editing-and-navigation">Editing and navigation</a><ul>
743+
<li><a class="reference internal" href="#editor-windows">Editor windows</a></li>
744+
<li><a class="reference internal" href="#key-bindings">Key bindings</a></li>
728745
<li><a class="reference internal" href="#automatic-indentation">Automatic indentation</a></li>
729746
<li><a class="reference internal" href="#completions">Completions</a></li>
730747
<li><a class="reference internal" href="#calltips">Calltips</a></li>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Add IDLE doc subsection explaining editor windows. Topics include opening,
2+
title and status bar, .py* extension, and running.

0 commit comments

Comments
 (0)