Skip to content

Commit 96a09df

Browse files
[doc] Fix a few margins due to bad markup (GH-23619)
1 parent bf353f3 commit 96a09df

11 files changed

+88
-89
lines changed

Doc/library/dialog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ These do not emulate the native look-and-feel of the platform.
198198
A subclass of FileDialog that creates a dialog window for selecting a
199199
destination file.
200200

201-
.. method:: ok_command()
201+
.. method:: ok_command()
202202

203203
Test whether or not the selection points to a valid file that is not a
204204
directory. Confirmation is required if an already existing file is

Doc/library/enum.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ helper, :class:`auto`.
6161
the bitwise operations without losing their :class:`Flag` membership.
6262

6363
.. function:: unique
64-
:noindex:
64+
:noindex:
6565

6666
Enum class decorator that ensures only one name is bound to any one value.
6767

Doc/library/logging.config.rst

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -35,45 +35,45 @@ in :mod:`logging` itself) and defining handlers which are declared either in
3535

3636
.. function:: dictConfig(config)
3737

38-
Takes the logging configuration from a dictionary. The contents of
39-
this dictionary are described in :ref:`logging-config-dictschema`
40-
below.
41-
42-
If an error is encountered during configuration, this function will
43-
raise a :exc:`ValueError`, :exc:`TypeError`, :exc:`AttributeError`
44-
or :exc:`ImportError` with a suitably descriptive message. The
45-
following is a (possibly incomplete) list of conditions which will
46-
raise an error:
47-
48-
* A ``level`` which is not a string or which is a string not
49-
corresponding to an actual logging level.
50-
* A ``propagate`` value which is not a boolean.
51-
* An id which does not have a corresponding destination.
52-
* A non-existent handler id found during an incremental call.
53-
* An invalid logger name.
54-
* Inability to resolve to an internal or external object.
55-
56-
Parsing is performed by the :class:`DictConfigurator` class, whose
57-
constructor is passed the dictionary used for configuration, and
58-
has a :meth:`configure` method. The :mod:`logging.config` module
59-
has a callable attribute :attr:`dictConfigClass`
60-
which is initially set to :class:`DictConfigurator`.
61-
You can replace the value of :attr:`dictConfigClass` with a
62-
suitable implementation of your own.
63-
64-
:func:`dictConfig` calls :attr:`dictConfigClass` passing
65-
the specified dictionary, and then calls the :meth:`configure` method on
66-
the returned object to put the configuration into effect::
67-
68-
def dictConfig(config):
69-
dictConfigClass(config).configure()
70-
71-
For example, a subclass of :class:`DictConfigurator` could call
72-
``DictConfigurator.__init__()`` in its own :meth:`__init__()`, then
73-
set up custom prefixes which would be usable in the subsequent
74-
:meth:`configure` call. :attr:`dictConfigClass` would be bound to
75-
this new subclass, and then :func:`dictConfig` could be called exactly as
76-
in the default, uncustomized state.
38+
Takes the logging configuration from a dictionary. The contents of
39+
this dictionary are described in :ref:`logging-config-dictschema`
40+
below.
41+
42+
If an error is encountered during configuration, this function will
43+
raise a :exc:`ValueError`, :exc:`TypeError`, :exc:`AttributeError`
44+
or :exc:`ImportError` with a suitably descriptive message. The
45+
following is a (possibly incomplete) list of conditions which will
46+
raise an error:
47+
48+
* A ``level`` which is not a string or which is a string not
49+
corresponding to an actual logging level.
50+
* A ``propagate`` value which is not a boolean.
51+
* An id which does not have a corresponding destination.
52+
* A non-existent handler id found during an incremental call.
53+
* An invalid logger name.
54+
* Inability to resolve to an internal or external object.
55+
56+
Parsing is performed by the :class:`DictConfigurator` class, whose
57+
constructor is passed the dictionary used for configuration, and
58+
has a :meth:`configure` method. The :mod:`logging.config` module
59+
has a callable attribute :attr:`dictConfigClass`
60+
which is initially set to :class:`DictConfigurator`.
61+
You can replace the value of :attr:`dictConfigClass` with a
62+
suitable implementation of your own.
63+
64+
:func:`dictConfig` calls :attr:`dictConfigClass` passing
65+
the specified dictionary, and then calls the :meth:`configure` method on
66+
the returned object to put the configuration into effect::
67+
68+
def dictConfig(config):
69+
dictConfigClass(config).configure()
70+
71+
For example, a subclass of :class:`DictConfigurator` could call
72+
``DictConfigurator.__init__()`` in its own :meth:`__init__()`, then
73+
set up custom prefixes which would be usable in the subsequent
74+
:meth:`configure` call. :attr:`dictConfigClass` would be bound to
75+
this new subclass, and then :func:`dictConfig` could be called exactly as
76+
in the default, uncustomized state.
7777

7878
.. versionadded:: 3.2
7979

Doc/library/os.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1323,12 +1323,12 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13231323

13241324
.. data:: RWF_APPEND
13251325

1326-
Provide a per-write equivalent of the :data:`O_APPEND` :func:`os.open`
1327-
flag. This flag is meaningful only for :func:`os.pwritev`, and its
1328-
effect applies only to the data range written by the system call. The
1329-
*offset* argument does not affect the write operation; the data is always
1330-
appended to the end of the file. However, if the *offset* argument is
1331-
``-1``, the current file *offset* is updated.
1326+
Provide a per-write equivalent of the :data:`O_APPEND` :func:`os.open`
1327+
flag. This flag is meaningful only for :func:`os.pwritev`, and its
1328+
effect applies only to the data range written by the system call. The
1329+
*offset* argument does not affect the write operation; the data is always
1330+
appended to the end of the file. However, if the *offset* argument is
1331+
``-1``, the current file *offset* is updated.
13321332

13331333
.. availability:: Linux 4.16 and newer.
13341334

Doc/library/platform.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,4 +290,4 @@ Linux Platforms
290290
ids.extend(info["ID_LIKE"].split())
291291
return ids
292292

293-
.. versionadded:: 3.10
293+
.. versionadded:: 3.10

Doc/library/profile.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -532,9 +532,9 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
532532
instance holds information related to the function's profile such as how
533533
long the function took to run, how many times it was called, etc...
534534

535-
.. versionadded:: 3.9
536-
Added the following dataclasses: StatsProfile, FunctionProfile.
537-
Added the following function: get_stats_profile.
535+
.. versionadded:: 3.9
536+
Added the following dataclasses: StatsProfile, FunctionProfile.
537+
Added the following function: get_stats_profile.
538538

539539
.. _deterministic-profiling:
540540

Doc/library/socket.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ created. Socket addresses are represented as follows:
5656
bytes-like object can be used for either type of address when
5757
passing it as an argument.
5858

59-
.. versionchanged:: 3.3
60-
Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8
61-
encoding.
59+
.. versionchanged:: 3.3
60+
Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8
61+
encoding.
6262

63-
.. versionchanged:: 3.5
64-
Writable :term:`bytes-like object` is now accepted.
63+
.. versionchanged:: 3.5
64+
Writable :term:`bytes-like object` is now accepted.
6565

6666
.. _host_port:
6767

Doc/library/symtable.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Examining Symbol Tables
156156

157157
Return ``True`` if the symbol is local to its block.
158158

159-
.. method:: is_annotated()
159+
.. method:: is_annotated()
160160

161161
Return ``True`` if the symbol is annotated.
162162

Doc/library/trace.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -153,47 +153,47 @@ Programmatic Interface
153153
count information. *timing* enables a timestamp relative to when tracing was
154154
started to be displayed.
155155

156-
.. method:: run(cmd)
156+
.. method:: run(cmd)
157157

158-
Execute the command and gather statistics from the execution with
159-
the current tracing parameters. *cmd* must be a string or code object,
160-
suitable for passing into :func:`exec`.
158+
Execute the command and gather statistics from the execution with
159+
the current tracing parameters. *cmd* must be a string or code object,
160+
suitable for passing into :func:`exec`.
161161

162-
.. method:: runctx(cmd, globals=None, locals=None)
162+
.. method:: runctx(cmd, globals=None, locals=None)
163163

164-
Execute the command and gather statistics from the execution with the
165-
current tracing parameters, in the defined global and local
166-
environments. If not defined, *globals* and *locals* default to empty
167-
dictionaries.
164+
Execute the command and gather statistics from the execution with the
165+
current tracing parameters, in the defined global and local
166+
environments. If not defined, *globals* and *locals* default to empty
167+
dictionaries.
168168

169-
.. method:: runfunc(func, /, *args, **kwds)
169+
.. method:: runfunc(func, /, *args, **kwds)
170170

171-
Call *func* with the given arguments under control of the :class:`Trace`
172-
object with the current tracing parameters.
171+
Call *func* with the given arguments under control of the :class:`Trace`
172+
object with the current tracing parameters.
173173

174-
.. method:: results()
174+
.. method:: results()
175175

176-
Return a :class:`CoverageResults` object that contains the cumulative
177-
results of all previous calls to ``run``, ``runctx`` and ``runfunc``
178-
for the given :class:`Trace` instance. Does not reset the accumulated
179-
trace results.
176+
Return a :class:`CoverageResults` object that contains the cumulative
177+
results of all previous calls to ``run``, ``runctx`` and ``runfunc``
178+
for the given :class:`Trace` instance. Does not reset the accumulated
179+
trace results.
180180

181181
.. class:: CoverageResults
182182

183183
A container for coverage results, created by :meth:`Trace.results`. Should
184184
not be created directly by the user.
185185

186-
.. method:: update(other)
186+
.. method:: update(other)
187187

188-
Merge in data from another :class:`CoverageResults` object.
188+
Merge in data from another :class:`CoverageResults` object.
189189

190-
.. method:: write_results(show_missing=True, summary=False, coverdir=None)
190+
.. method:: write_results(show_missing=True, summary=False, coverdir=None)
191191

192-
Write coverage results. Set *show_missing* to show lines that had no
193-
hits. Set *summary* to include in the output the coverage summary per
194-
module. *coverdir* specifies the directory into which the coverage
195-
result files will be output. If ``None``, the results for each source
196-
file are placed in its directory.
192+
Write coverage results. Set *show_missing* to show lines that had no
193+
hits. Set *summary* to include in the output the coverage summary per
194+
module. *coverdir* specifies the directory into which the coverage
195+
result files will be output. If ``None``, the results for each source
196+
file are placed in its directory.
197197

198198
A simple example demonstrating the use of the programmatic interface::
199199

Doc/library/turtle.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -913,8 +913,8 @@ Color control
913913
Set pencolor to the RGB color represented by *r*, *g*, and *b*. Each of
914914
*r*, *g*, and *b* must be in the range 0..colormode.
915915

916-
If turtleshape is a polygon, the outline of that polygon is drawn with the
917-
newly set pencolor.
916+
If turtleshape is a polygon, the outline of that polygon is drawn with the
917+
newly set pencolor.
918918

919919
.. doctest::
920920
:skipif: _tkinter is None
@@ -962,8 +962,8 @@ Color control
962962
Set fillcolor to the RGB color represented by *r*, *g*, and *b*. Each of
963963
*r*, *g*, and *b* must be in the range 0..colormode.
964964

965-
If turtleshape is a polygon, the interior of that polygon is drawn
966-
with the newly set fillcolor.
965+
If turtleshape is a polygon, the interior of that polygon is drawn
966+
with the newly set fillcolor.
967967

968968
.. doctest::
969969
:skipif: _tkinter is None
@@ -1001,8 +1001,8 @@ Color control
10011001
Equivalent to ``pencolor(colorstring1)`` and ``fillcolor(colorstring2)``
10021002
and analogously if the other input format is used.
10031003

1004-
If turtleshape is a polygon, outline and interior of that polygon is drawn
1005-
with the newly set colors.
1004+
If turtleshape is a polygon, outline and interior of that polygon is drawn
1005+
with the newly set colors.
10061006

10071007
.. doctest::
10081008
:skipif: _tkinter is None

Doc/reference/datamodel.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,6 @@ Ellipsis
217217
There are two types of integers:
218218

219219
Integers (:class:`int`)
220-
221220
These represent numbers in an unlimited range, subject to available (virtual)
222221
memory only. For the purpose of shift and mask operations, a binary
223222
representation is assumed, and negative numbers are represented in a variant of

0 commit comments

Comments
 (0)