Skip to content

Commit

Permalink
[3.9] [doc] Fix a few margins due to bad markup (GH-23619). (GH-23859)
Browse files Browse the repository at this point in the history
(cherry picked from commit 96a09df)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
  • Loading branch information
andresdelfino committed Dec 22, 2020
1 parent e89993c commit 7c48859
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 81 deletions.
2 changes: 1 addition & 1 deletion Doc/library/dialog.rst
Expand Up @@ -198,7 +198,7 @@ These do not emulate the native look-and-feel of the platform.
A subclass of FileDialog that creates a dialog window for selecting a
destination file.

.. method:: ok_command()
.. method:: ok_command()

Test whether or not the selection points to a valid file that is not a
directory. Confirmation is required if an already existing file is
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/enum.rst
Expand Up @@ -56,7 +56,7 @@ helper, :class:`auto`.
the bitwise operations without losing their :class:`Flag` membership.

.. function:: unique
:noindex:
:noindex:

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

Expand Down
78 changes: 39 additions & 39 deletions Doc/library/logging.config.rst
Expand Up @@ -35,45 +35,45 @@ in :mod:`logging` itself) and defining handlers which are declared either in

.. function:: dictConfig(config)

Takes the logging configuration from a dictionary. The contents of
this dictionary are described in :ref:`logging-config-dictschema`
below.

If an error is encountered during configuration, this function will
raise a :exc:`ValueError`, :exc:`TypeError`, :exc:`AttributeError`
or :exc:`ImportError` with a suitably descriptive message. The
following is a (possibly incomplete) list of conditions which will
raise an error:

* A ``level`` which is not a string or which is a string not
corresponding to an actual logging level.
* A ``propagate`` value which is not a boolean.
* An id which does not have a corresponding destination.
* A non-existent handler id found during an incremental call.
* An invalid logger name.
* Inability to resolve to an internal or external object.

Parsing is performed by the :class:`DictConfigurator` class, whose
constructor is passed the dictionary used for configuration, and
has a :meth:`configure` method. The :mod:`logging.config` module
has a callable attribute :attr:`dictConfigClass`
which is initially set to :class:`DictConfigurator`.
You can replace the value of :attr:`dictConfigClass` with a
suitable implementation of your own.

:func:`dictConfig` calls :attr:`dictConfigClass` passing
the specified dictionary, and then calls the :meth:`configure` method on
the returned object to put the configuration into effect::

def dictConfig(config):
dictConfigClass(config).configure()

For example, a subclass of :class:`DictConfigurator` could call
``DictConfigurator.__init__()`` in its own :meth:`__init__()`, then
set up custom prefixes which would be usable in the subsequent
:meth:`configure` call. :attr:`dictConfigClass` would be bound to
this new subclass, and then :func:`dictConfig` could be called exactly as
in the default, uncustomized state.
Takes the logging configuration from a dictionary. The contents of
this dictionary are described in :ref:`logging-config-dictschema`
below.

If an error is encountered during configuration, this function will
raise a :exc:`ValueError`, :exc:`TypeError`, :exc:`AttributeError`
or :exc:`ImportError` with a suitably descriptive message. The
following is a (possibly incomplete) list of conditions which will
raise an error:

* A ``level`` which is not a string or which is a string not
corresponding to an actual logging level.
* A ``propagate`` value which is not a boolean.
* An id which does not have a corresponding destination.
* A non-existent handler id found during an incremental call.
* An invalid logger name.
* Inability to resolve to an internal or external object.

Parsing is performed by the :class:`DictConfigurator` class, whose
constructor is passed the dictionary used for configuration, and
has a :meth:`configure` method. The :mod:`logging.config` module
has a callable attribute :attr:`dictConfigClass`
which is initially set to :class:`DictConfigurator`.
You can replace the value of :attr:`dictConfigClass` with a
suitable implementation of your own.

:func:`dictConfig` calls :attr:`dictConfigClass` passing
the specified dictionary, and then calls the :meth:`configure` method on
the returned object to put the configuration into effect::

def dictConfig(config):
dictConfigClass(config).configure()

For example, a subclass of :class:`DictConfigurator` could call
``DictConfigurator.__init__()`` in its own :meth:`__init__()`, then
set up custom prefixes which would be usable in the subsequent
:meth:`configure` call. :attr:`dictConfigClass` would be bound to
this new subclass, and then :func:`dictConfig` could be called exactly as
in the default, uncustomized state.

.. versionadded:: 3.2

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/profile.rst
Expand Up @@ -532,9 +532,9 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
instance holds information related to the function's profile such as how
long the function took to run, how many times it was called, etc...

.. versionadded:: 3.9
Added the following dataclasses: StatsProfile, FunctionProfile.
Added the following function: get_stats_profile.
.. versionadded:: 3.9
Added the following dataclasses: StatsProfile, FunctionProfile.
Added the following function: get_stats_profile.

.. _deterministic-profiling:

Expand Down
10 changes: 5 additions & 5 deletions Doc/library/socket.rst
Expand Up @@ -56,12 +56,12 @@ created. Socket addresses are represented as follows:
bytes-like object can be used for either type of address when
passing it as an argument.

.. versionchanged:: 3.3
Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8
encoding.
.. versionchanged:: 3.3
Previously, :const:`AF_UNIX` socket paths were assumed to use UTF-8
encoding.

.. versionchanged:: 3.5
Writable :term:`bytes-like object` is now accepted.
.. versionchanged:: 3.5
Writable :term:`bytes-like object` is now accepted.

.. _host_port:

Expand Down
50 changes: 25 additions & 25 deletions Doc/library/trace.rst
Expand Up @@ -153,47 +153,47 @@ Programmatic Interface
count information. *timing* enables a timestamp relative to when tracing was
started to be displayed.

.. method:: run(cmd)
.. method:: run(cmd)

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

.. method:: runctx(cmd, globals=None, locals=None)
.. method:: runctx(cmd, globals=None, locals=None)

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

.. method:: runfunc(func, /, *args, **kwds)
.. method:: runfunc(func, /, *args, **kwds)

Call *func* with the given arguments under control of the :class:`Trace`
object with the current tracing parameters.
Call *func* with the given arguments under control of the :class:`Trace`
object with the current tracing parameters.

.. method:: results()
.. method:: results()

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

.. class:: CoverageResults

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

.. method:: update(other)
.. method:: update(other)

Merge in data from another :class:`CoverageResults` object.
Merge in data from another :class:`CoverageResults` object.

.. method:: write_results(show_missing=True, summary=False, coverdir=None)
.. method:: write_results(show_missing=True, summary=False, coverdir=None)

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

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

Expand Down
12 changes: 6 additions & 6 deletions Doc/library/turtle.rst
Expand Up @@ -913,8 +913,8 @@ Color control
Set pencolor to the RGB color represented by *r*, *g*, and *b*. Each of
*r*, *g*, and *b* must be in the range 0..colormode.

If turtleshape is a polygon, the outline of that polygon is drawn with the
newly set pencolor.
If turtleshape is a polygon, the outline of that polygon is drawn with the
newly set pencolor.

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

If turtleshape is a polygon, the interior of that polygon is drawn
with the newly set fillcolor.
If turtleshape is a polygon, the interior of that polygon is drawn
with the newly set fillcolor.

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

If turtleshape is a polygon, outline and interior of that polygon is drawn
with the newly set colors.
If turtleshape is a polygon, outline and interior of that polygon is drawn
with the newly set colors.

.. doctest::
:skipif: _tkinter is None
Expand Down
1 change: 0 additions & 1 deletion Doc/reference/datamodel.rst
Expand Up @@ -217,7 +217,6 @@ Ellipsis
There are two types of integers:

Integers (:class:`int`)

These represent numbers in an unlimited range, subject to available (virtual)
memory only. For the purpose of shift and mask operations, a binary
representation is assumed, and negative numbers are represented in a variant of
Expand Down

0 comments on commit 7c48859

Please sign in to comment.