]> granicus.if.org Git - python/commitdiff
Issue #16893: For Idle doc, move index entries, copy no-subprocess section
authorTerry Jan Reedy <tjreedy@udel.edu>
Thu, 4 Dec 2014 05:54:59 +0000 (00:54 -0500)
committerTerry Jan Reedy <tjreedy@udel.edu>
Thu, 4 Dec 2014 05:54:59 +0000 (00:54 -0500)
from idlelib/help.txt, add 'C' comment, and remove obsolete ^Z comment
Original patch by Zach Ware.

Doc/library/idle.rst

index 2718cef3d5e3b798966a86a7314ecee53fd1c639..119e961e6aa6c2c845b4ef0f20590e43648b45fc 100644 (file)
@@ -1,15 +1,15 @@
 .. _idle:
 
-IDLE
-====
-
-.. moduleauthor:: Guido van Rossum <guido@Python.org>
-
 .. index::
    single: IDLE
    single: Python Editor
    single: Integrated Development Environment
 
+IDLE
+====
+
+.. moduleauthor:: Guido van Rossum <guido@Python.org>
+
 IDLE is the Python IDE built with the :mod:`tkinter` GUI toolkit.
 
 IDLE has the following features:
@@ -51,16 +51,16 @@ Open module...
 Recent Files
    Open a list of recent files
 
+.. index::
+   single: Class browser
+   single: Path browser
+
 Class browser
    Show classes and methods in current file
 
 Path browser
    Show sys.path directories, modules, classes and methods
 
-.. index::
-   single: Class browser
-   single: Path browser
-
 Save
    Save current window to the associated file (unsaved windows have a
    \* before and after the window title)
@@ -137,7 +137,7 @@ Show Completions
 
 
 Format menu (Editor window only)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Indent region
    Shift selected lines right by the indent width (default 4 spaces)
@@ -263,6 +263,14 @@ Python Docs
 Additional help sources may be added here with the Configure IDLE dialog under
 the General tab.
 
+.. index::
+   single: Cut
+   single: Copy
+   single: Paste
+   single: Set Breakpoint
+   single: Clear Breakpoint
+   single: breakpoints
+
 Editor Window context menu
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -283,15 +291,6 @@ Set Breakpoint
 Clear Breakpoint
    Clears the breakpoint on that line.
 
-.. index::
-   single: Cut
-   single: Copy
-   single: Paste
-   single: Set Breakpoint
-   single: Clear Breakpoint
-   single: breakpoints
-
-
 Shell Window context menu
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -313,6 +312,9 @@ Go to file/line
 Editing and navigation
 ----------------------
 
+In this section, 'C' refers to the Control key on Windows and Unix and
+the Command key on Mac OSX.
+
 * :kbd:`Backspace` deletes to the left; :kbd:`Del` deletes to the right
 
 * :kbd:`C-Backspace` delete word left; :kbd:`C-Del` delete word to the right
@@ -414,7 +416,6 @@ Python Shell window
 * :kbd:`C-c` interrupts executing command
 
 * :kbd:`C-d` sends end-of-file; closes window if typed at a ``>>>`` prompt
-  (this is :kbd:`C-z` on Windows).
 
 * :kbd:`Alt-/` (Expand word) is also useful to reduce typing
 
@@ -507,6 +508,22 @@ If there are arguments:
    name is '-', no script is executed but an interactive Python session is started;
    the arguments are still available in ``sys.argv``.
 
+Running without a subprocess
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If IDLE is started with the -n command line switch it will run in a
+single process and will not create the subprocess which runs the RPC
+Python execution server.  This can be useful if Python cannot create
+the subprocess or the RPC socket interface on your platform.  However,
+in this mode user code is not isolated from IDLE itself.  Also, the
+environment is not restarted when Run/Run Module (F5) is selected.  If
+your code has been modified, you must reload() the affected modules and
+re-import any specific items (e.g. from foo import baz) if the changes
+are to take effect.  For these reasons, it is preferable to run IDLE
+with the default subprocess if at all possible.
+
+.. deprecated:: 3.4
+
 
 Additional help sources
 -----------------------
@@ -527,6 +544,7 @@ keys can be user defined, IDLE ships with four built in key sets. In
 addition a user can create a custom key set in the Configure IDLE dialog
 under the keys tab.
 
+
 Extensions
 ----------