Skip to content

Commit

Permalink
bpo-1529353: Explain Shell text squeezing in the IDLE doc. (#10169)
Browse files Browse the repository at this point in the history
  • Loading branch information
terryjreedy committed Oct 28, 2018
1 parent c8a8d6b commit 68d6dc0
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
21 changes: 20 additions & 1 deletion Doc/library/idle.rst
Expand Up @@ -341,11 +341,18 @@ Set Breakpoint
Clear Breakpoint
Clear the breakpoint on that line.

Shell and Output windows have the following.
Shell and Output windows also have the following.

Go to file/line
Same as in Debug menu.

The Shell window also has an output squeezing facility explained in the
the *Python Shell window* subsection below.

Squeeze
If the cursor is over an output line, squeeze all the output between
the code above and the prompt below down to a 'Squeezed text' label.


Editing and navigation
----------------------
Expand Down Expand Up @@ -477,6 +484,9 @@ or immediately run an existing file before editing.
Python Shell window
^^^^^^^^^^^^^^^^^^^

The editing features described above work when entering code interactively.
IDLE's Shell window also responds to the following keys.

* :kbd:`C-c` interrupts executing command

* :kbd:`C-d` sends end-of-file; closes window if typed at a ``>>>`` prompt
Expand All @@ -492,6 +502,15 @@ Python Shell window

* :kbd:`Return` while on any previous command retrieves that command

Shell has a special facility for squeezing output lines down to a
'Squeezed text' label. This is done automatically for output over N lines
(N = 50 by default). N can be changed in the PyShell section of the General
page of the Settings dialog. Output with fewer lines can be squeezed by
right clicking on the output. This can be useful for extra long lines.

Squeezed output is expanded in place by double-clicking the label.
It can also be sent to the clipboard or a separate view window by
right-clicking the label.

Text colors
^^^^^^^^^^^
Expand Down
21 changes: 19 additions & 2 deletions Lib/idlelib/help.html
Expand Up @@ -364,11 +364,18 @@ <h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and
<dt>Clear Breakpoint</dt>
<dd>Clear the breakpoint on that line.</dd>
</dl>
<p>Shell and Output windows have the following.</p>
<p>Shell and Output windows also have the following.</p>
<dl class="docutils">
<dt>Go to file/line</dt>
<dd>Same as in Debug menu.</dd>
</dl>
<p>The Shell window also has an output squeezing facility explained in the
the <em>Python Shell window</em> subsection below.</p>
<dl class="docutils">
<dt>Squeeze</dt>
<dd>If the cursor is over an output line, squeeze all the output between
the code above and the prompt below down to a ‘Squeezed text’ label.</dd>
</dl>
</div>
</div>
<div class="section" id="editing-and-navigation">
Expand Down Expand Up @@ -478,6 +485,8 @@ <h3>Calltips<a class="headerlink" href="#calltips" title="Permalink to this head
</div>
<div class="section" id="python-shell-window">
<h3>Python Shell window<a class="headerlink" href="#python-shell-window" title="Permalink to this headline"></a></h3>
<p>The editing features described above work when entering code interactively.
IDLE’s Shell window also responds to the following keys.</p>
<ul>
<li><p class="first"><kbd class="kbd docutils literal notranslate">C-c</kbd> interrupts executing command</p>
</li>
Expand All @@ -493,6 +502,14 @@ <h3>Python Shell window<a class="headerlink" href="#python-shell-window" title="
</ul>
</li>
</ul>
<p>Shell has a special facility for squeezing output lines down to a
‘Squeezed text’ label. This is done automatically for output over N lines
(N = 50 by default). N can be changed in the PyShell section of the General
page of the Settings dialog. Output with fewer lines can be squeezed by
right clicking on the output. This can be useful for extra long lines.</p>
<p>Squeezed output is expanded in place by double-clicking the label.
It can also be sent to the clipboard or a separate view window by
right-clicking the label.</p>
</div>
<div class="section" id="text-colors">
<h3>Text colors<a class="headerlink" href="#text-colors" title="Permalink to this headline"></a></h3>
Expand Down Expand Up @@ -797,7 +814,7 @@ <h3>Navigation</h3>
<br />
<br />

Last updated on Oct 27, 2018.
Last updated on Oct 28, 2018.
<a href="https://docs.python.org/3/bugs.html">Found a bug</a>?
<br />

Expand Down

0 comments on commit 68d6dc0

Please sign in to comment.