Skip to content

Commit d6c08db

Browse files
taleinatterryjreedy
authored andcommitted
Minor formatting improvements and fixes to idle.rst (pythonGH-17165)
1 parent 94d9cfc commit d6c08db

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

Doc/library/idle.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,8 @@ Paste
370370

371371
Editor windows also have breakpoint functions. Lines with a breakpoint set are
372372
specially marked. Breakpoints only have an effect when running under the
373-
debugger. Breakpoints for a file are saved in the user's .idlerc directory.
373+
debugger. Breakpoints for a file are saved in the user's ``.idlerc``
374+
directory.
374375

375376
Set Breakpoint
376377
Set a breakpoint on the current line.
@@ -685,14 +686,14 @@ crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing
685686
the error box or Restart Shell on the Shell menu may fix a temporary problem.
686687

687688
When IDLE first starts, it attempts to read user configuration files in
688-
~/.idlerc/ (~ is one's home directory). If there is a problem, an error
689+
``~/.idlerc/`` (~ is one's home directory). If there is a problem, an error
689690
message should be displayed. Leaving aside random disk glitches, this can
690691
be prevented by never editing the files by hand, using the configuration
691692
dialog, under Options, instead Options. Once it happens, the solution may
692693
be to delete one or more of the configuration files.
693694

694695
If IDLE quits with no message, and it was not started from a console, try
695-
starting from a console (``python -m idlelib)`` and see if a message appears.
696+
starting from a console (``python -m idlelib``) and see if a message appears.
696697

697698
Running user code
698699
^^^^^^^^^^^^^^^^^
@@ -863,13 +864,13 @@ Or click the TOC (Table of Contents) button and select a section
863864
header in the opened box.
864865

865866
Help menu entry "Python Docs" opens the extensive sources of help,
866-
including tutorials, available at docs.python.org/x.y, where 'x.y'
867+
including tutorials, available at ``docs.python.org/x.y``, where 'x.y'
867868
is the currently running Python version. If your system
868869
has an off-line copy of the docs (this may be an installation option),
869870
that will be opened instead.
870871

871872
Selected URLs can be added or removed from the help menu at any time using the
872-
General tab of the Configure IDLE dialog .
873+
General tab of the Configure IDLE dialog.
873874

874875
.. _preferences:
875876

@@ -878,9 +879,9 @@ Setting preferences
878879

879880
The font preferences, highlighting, keys, and general preferences can be
880881
changed via Configure IDLE on the Option menu.
881-
Non-default user settings are saved in a .idlerc directory in the user's
882+
Non-default user settings are saved in a ``.idlerc`` directory in the user's
882883
home directory. Problems caused by bad user configuration files are solved
883-
by editing or deleting one or more of the files in .idlerc.
884+
by editing or deleting one or more of the files in ``.idlerc``.
884885

885886
On the Font tab, see the text sample for the effect of font face and size
886887
on multiple characters in multiple languages. Edit the sample to add

Lib/idlelib/help.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,8 @@ <h3>Help menu (Shell and Editor)<a class="headerlink" href="#help-menu-shell-and
382382
</dl>
383383
<p>Editor windows also have breakpoint functions. Lines with a breakpoint set are
384384
specially marked. Breakpoints only have an effect when running under the
385-
debugger. Breakpoints for a file are saved in the user’s .idlerc directory.</p>
385+
debugger. Breakpoints for a file are saved in the user’s <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code>
386+
directory.</p>
386387
<dl class="simple">
387388
<dt>Set Breakpoint</dt><dd><p>Set a breakpoint on the current line.</p>
388389
</dd>
@@ -638,13 +639,13 @@ <h3>Startup failure<a class="headerlink" href="#startup-failure" title="Permalin
638639
crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing
639640
the error box or Restart Shell on the Shell menu may fix a temporary problem.</p>
640641
<p>When IDLE first starts, it attempts to read user configuration files in
641-
~/.idlerc/ (~ is one’s home directory). If there is a problem, an error
642+
<code class="docutils literal notranslate"><span class="pre">~/.idlerc/</span></code> (~ is one’s home directory). If there is a problem, an error
642643
message should be displayed. Leaving aside random disk glitches, this can
643644
be prevented by never editing the files by hand, using the configuration
644645
dialog, under Options, instead Options. Once it happens, the solution may
645646
be to delete one or more of the configuration files.</p>
646647
<p>If IDLE quits with no message, and it was not started from a console, try
647-
starting from a console (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">idlelib)</span></code> and see if a message appears.</p>
648+
starting from a console (<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">idlelib</span></code>) and see if a message appears.</p>
648649
</div>
649650
<div class="section" id="running-user-code">
650651
<h3>Running user code<a class="headerlink" href="#running-user-code" title="Permalink to this headline"></a></h3>
@@ -791,20 +792,20 @@ <h2>Help and preferences<a class="headerlink" href="#help-and-preferences" title
791792
Or click the TOC (Table of Contents) button and select a section
792793
header in the opened box.</p>
793794
<p>Help menu entry “Python Docs” opens the extensive sources of help,
794-
including tutorials, available at docs.python.org/x.y, where ‘x.y’
795+
including tutorials, available at <code class="docutils literal notranslate"><span class="pre">docs.python.org/x.y</span></code>, where ‘x.y’
795796
is the currently running Python version. If your system
796797
has an off-line copy of the docs (this may be an installation option),
797798
that will be opened instead.</p>
798799
<p>Selected URLs can be added or removed from the help menu at any time using the
799-
General tab of the Configure IDLE dialog .</p>
800+
General tab of the Configure IDLE dialog.</p>
800801
</div>
801802
<div class="section" id="setting-preferences">
802803
<span id="preferences"></span><h3>Setting preferences<a class="headerlink" href="#setting-preferences" title="Permalink to this headline"></a></h3>
803804
<p>The font preferences, highlighting, keys, and general preferences can be
804805
changed via Configure IDLE on the Option menu.
805-
Non-default user settings are saved in a .idlerc directory in the user’s
806+
Non-default user settings are saved in a <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code> directory in the user’s
806807
home directory. Problems caused by bad user configuration files are solved
807-
by editing or deleting one or more of the files in .idlerc.</p>
808+
by editing or deleting one or more of the files in <code class="docutils literal notranslate"><span class="pre">.idlerc</span></code>.</p>
808809
<p>On the Font tab, see the text sample for the effect of font face and size
809810
on multiple characters in multiple languages. Edit the sample to add
810811
other characters of personal interest. Use the sample to select

0 commit comments

Comments
 (0)