From 292cd6e33104d9f458232a14998fe5c62f7f7e81 Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Thu, 20 Dec 2018 06:06:29 -0500 Subject: [PATCH] bpo-35521: Add more cross-refs to IDLE docs (#11257) Format menu and preferences. --- Doc/library/idle.rst | 31 +++++++++++++++++++------------ Lib/idlelib/help.html | 34 ++++++++++++++++++---------------- 2 files changed, 37 insertions(+), 28 deletions(-) diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index 449e54f067..80a2fdc4bf 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -160,6 +160,8 @@ Show call tip Show surrounding parens Highlight the surrounding parenthesis. +.. _format-menu: + Format menu (Editor window only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -268,14 +270,10 @@ Options menu (Shell and Editor) Configure IDLE Open a configuration dialog and change preferences for the following: fonts, indentation, keybindings, text color themes, startup windows and - size, additional help sources, and extensions (see below). On macOS, - open the configuration dialog by selecting Preferences in the application - menu. To use a new built-in color theme (IDLE Dark) with older IDLEs, - save it as a new custom theme. - - Non-default user settings are saved in a .idlerc directory in the user's - home directory. Problems caused by bad user configuration files are solved - by editing or deleting one or more of the files in .idlerc. + size, additional help sources, and extensions. On macOS, open the + configuration dialog by selecting Preferences in the application + menu. For more, see + :ref:`Setting preferences ` under Help and preferences. Code Context (toggle)(Editor Window only) Open a pane at the top of the edit window which shows the block context @@ -432,7 +430,8 @@ to 4 spaces if they are there. :kbd:`Tab` inserts spaces (in the Python Shell window one tab), number depends on Indent width. Currently, tabs are restricted to four spaces due to Tcl/Tk limitations. -See also the indent/dedent region commands in the edit menu. +See also the indent/dedent region commands on the +:ref:`Format menu `. .. _completions: @@ -817,13 +816,21 @@ that will be opened instead. Selected URLs can be added or removed from the help menu at any time using the General tab of the Configure IDLE dialog . +.. _preferences: + Setting preferences ^^^^^^^^^^^^^^^^^^^ The font preferences, highlighting, keys, and general preferences can be -changed via Configure IDLE on the Option menu. 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. +changed via Configure IDLE on the Option menu. +Non-default user settings are saved in a .idlerc directory in the user's +home directory. Problems caused by bad user configuration files are solved +by editing or deleting one or more of the files in .idlerc. + +On the Highlights and Keys tab, select a built-in or custom color theme +and key set. To use a newer built-in color theme or key set with older +IDLEs, save it as a new custom theme or key set and it well be accessible +to older IDLEs. IDLE on macOS ^^^^^^^^^^^^^ diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html index b5f12d1a6f..051690bc66 100644 --- a/Lib/idlelib/help.html +++ b/Lib/idlelib/help.html @@ -215,7 +215,7 @@ Editing and navigation section below.
-

Format menu (Editor window only)¶

+

Format menu (Editor window only)¶

Indent Region
Shift selected lines right by the indent width (default 4 spaces).
@@ -303,16 +303,12 @@ access to locals and globals.

Options menu (Shell and Editor)¶

Configure IDLE
-

Open a configuration dialog and change preferences for the following: +

Open a configuration dialog and change preferences for the following: fonts, indentation, keybindings, text color themes, startup windows and -size, additional help sources, and extensions (see below). On macOS, -open the configuration dialog by selecting Preferences in the application -menu. To use a new built-in color theme (IDLE Dark) with older IDLEs, -save it as a new custom theme.

-

Non-default user settings are saved in a .idlerc directory in the user’s -home directory. Problems caused by bad user configuration files are solved -by editing or deleting one or more of the files in .idlerc.

-
+size, additional help sources, and extensions. On macOS, open the +configuration dialog by selecting Preferences in the application +menu. For more, see +Setting preferences under Help and preferences.
Code Context (toggle)(Editor Window only)
Open a pane at the top of the edit window which shows the block context of the code which has scrolled above the top of the window. See @@ -443,7 +439,8 @@ the next line is dedented. In leading indentation, Tab inserts spaces (in the Python Shell window one tab), number depends on Indent width. Currently, tabs are restricted to four spaces due to Tcl/Tk limitations.

-

See also the indent/dedent region commands in the edit menu.

+

See also the indent/dedent region commands on the +Format menu.

Completions¶

@@ -766,11 +763,16 @@ that will be opened instead.

General tab of the Configure IDLE dialog .

-

Setting preferences¶

+

Setting preferences¶

The font preferences, highlighting, keys, and general preferences can be -changed via Configure IDLE on the Option menu. 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.

+changed via Configure IDLE on the Option menu. +Non-default user settings are saved in a .idlerc directory in the user’s +home directory. Problems caused by bad user configuration files are solved +by editing or deleting one or more of the files in .idlerc.

+

On the Highlights and Keys tab, select a built-in or custom color theme +and key set. To use a newer built-in color theme or key set with older +IDLEs, save it as a new custom theme or key set and it well be accessible +to older IDLEs.

IDLE on macOS¶

@@ -916,7 +918,7 @@ also used for testing.



- Last updated on Dec 19, 2018. + Last updated on Dec 20, 2018. Found a bug?
-- 2.40.0