summaryrefslogtreecommitdiffstats
path: root/Lib/idlelib
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2022-08-09 18:34:42 (GMT)
committerGitHub <noreply@github.com>2022-08-09 18:34:42 (GMT)
commit70fc9641b56144854777aef29c145cd10789e3df (patch)
tree224bf89ba5b899935bbd400dcef8ceaf546e78c4 /Lib/idlelib
parent141f2517fc36cc7a0caf177f270edb6d39cf3d23 (diff)
downloadcpython-70fc9641b56144854777aef29c145cd10789e3df.zip
cpython-70fc9641b56144854777aef29c145cd10789e3df.tar.gz
cpython-70fc9641b56144854777aef29c145cd10789e3df.tar.bz2
gh-75500: Add idlelib section to IDLE doc (#95832)
This enables accessing IDLE as 'idlelib' in the Doc Module listing.
Diffstat (limited to 'Lib/idlelib')
-rw-r--r--Lib/idlelib/help.html15
1 files changed, 14 insertions, 1 deletions
diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html
index ac38612..af5cbd5 100644
--- a/Lib/idlelib/help.html
+++ b/Lib/idlelib/help.html
@@ -113,6 +113,7 @@
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
<li><a class="reference internal" href="#extensions">Extensions</a></li>
+<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
</ul>
</li>
</ul>
@@ -1001,6 +1002,17 @@ beginning of config-extensions.def in the idlelib directory for further
information. The only current default extension is zzdummy, an example
also used for testing.</p>
</section>
+<section id="module-idlelib">
+<span id="idlelib"></span><h3>idlelib<a class="headerlink" href="#module-idlelib" title="Permalink to this heading">¶</a></h3>
+<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/main/Lib/idlelib">Lib/idlelib</a></p>
+<p>The Lib/idlelib package implements the IDLE application. See the top
+of this file or content listing on the left for how to use IDLE.</p>
+<p>The files in idlelib are described in idlelib/README.txt. Access it
+either in idlelib or click Help =&gt; About IDLE on the IDLE menu. This
+file also maps IDLE menu items to the code that implements the item.
+Except for files listed under ‘Startup’, the idlelib code is ‘private’ in
+sense that feature changes can be backported (see <span class="target" id="index-7"></span><a class="pep reference external" href="https://peps.python.org/pep-0434/"><strong>PEP 434</strong></a>).</p>
+</section>
</section>
</section>
@@ -1054,6 +1066,7 @@ also used for testing.</p>
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
<li><a class="reference internal" href="#extensions">Extensions</a></li>
+<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
</ul>
</li>
</ul>
@@ -1153,7 +1166,7 @@ also used for testing.</p>
<br />
<br />
- Last updated on Aug 05, 2022.
+ Last updated on Aug 07, 2022.
<a href="/bugs.html">Found a bug</a>?
<br />