Skip to content

Commit 1956f7b

Browse files
[3.11] Normalize heading underline in multiprocessing.rst (pythonGH-114923) (python#114947)
This gets rid of the mildly confusing `>>>>>>>' underlines which look vaguely like `diff` punctuation. (cherry picked from commit 00d7109) Co-authored-by: Skip Montanaro <[email protected]>
1 parent b833b00 commit 1956f7b

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

Doc/library/multiprocessing.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ will print to standard output ::
5656

5757

5858
The :class:`Process` class
59-
~~~~~~~~~~~~~~~~~~~~~~~~~~
59+
^^^^^^^^^^^^^^^^^^^^^^^^^^
6060

6161
In :mod:`multiprocessing`, processes are spawned by creating a :class:`Process`
6262
object and then calling its :meth:`~Process.start` method. :class:`Process`
@@ -100,7 +100,7 @@ necessary, see :ref:`multiprocessing-programming`.
100100

101101

102102
Contexts and start methods
103-
~~~~~~~~~~~~~~~~~~~~~~~~~~
103+
^^^^^^^^^^^^^^^^^^^^^^^^^^
104104

105105
.. _multiprocessing-start-methods:
106106

@@ -218,7 +218,7 @@ library user.
218218

219219

220220
Exchanging objects between processes
221-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
222222

223223
:mod:`multiprocessing` supports two types of communication channel between
224224
processes:
@@ -270,7 +270,7 @@ processes:
270270

271271

272272
Synchronization between processes
273-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
274274

275275
:mod:`multiprocessing` contains equivalents of all the synchronization
276276
primitives from :mod:`threading`. For instance one can use a lock to ensure
@@ -296,7 +296,7 @@ mixed up.
296296

297297

298298
Sharing state between processes
299-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
300300

301301
As mentioned above, when doing concurrent programming it is usually best to
302302
avoid using shared state as far as possible. This is particularly true when
@@ -386,7 +386,7 @@ However, if you really do need to use some shared data then
386386

387387

388388
Using a pool of workers
389-
~~~~~~~~~~~~~~~~~~~~~~~
389+
^^^^^^^^^^^^^^^^^^^^^^^
390390

391391
The :class:`~multiprocessing.pool.Pool` class represents a pool of worker
392392
processes. It has methods which allows tasks to be offloaded to the worker
@@ -477,7 +477,7 @@ The :mod:`multiprocessing` package mostly replicates the API of the
477477

478478

479479
:class:`Process` and exceptions
480-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
480+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
481481

482482
.. class:: Process(group=None, target=None, name=None, args=(), kwargs={}, \
483483
*, daemon=None)
@@ -710,7 +710,7 @@ The :mod:`multiprocessing` package mostly replicates the API of the
710710
Raised by methods with a timeout when the timeout expires.
711711

712712
Pipes and Queues
713-
~~~~~~~~~~~~~~~~
713+
^^^^^^^^^^^^^^^^
714714

715715
When using multiple processes, one generally uses message passing for
716716
communication between processes and avoids having to use any synchronization
@@ -967,7 +967,7 @@ For an example of the usage of queues for interprocess communication see
967967

968968

969969
Miscellaneous
970-
~~~~~~~~~~~~~
970+
^^^^^^^^^^^^^
971971

972972
.. function:: active_children()
973973

@@ -1113,7 +1113,7 @@ Miscellaneous
11131113

11141114

11151115
Connection Objects
1116-
~~~~~~~~~~~~~~~~~~
1116+
^^^^^^^^^^^^^^^^^^
11171117

11181118
.. currentmodule:: multiprocessing.connection
11191119

@@ -1255,7 +1255,7 @@ For example:
12551255

12561256

12571257
Synchronization primitives
1258-
~~~~~~~~~~~~~~~~~~~~~~~~~~
1258+
^^^^^^^^^^^^^^^^^^^^^^^^^^
12591259

12601260
.. currentmodule:: multiprocessing
12611261

@@ -1444,7 +1444,7 @@ object -- see :ref:`multiprocessing-managers`.
14441444

14451445

14461446
Shared :mod:`ctypes` Objects
1447-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1447+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14481448

14491449
It is possible to create shared objects using shared memory which can be
14501450
inherited by child processes.
@@ -1506,7 +1506,7 @@ inherited by child processes.
15061506

15071507

15081508
The :mod:`multiprocessing.sharedctypes` module
1509-
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
1509+
""""""""""""""""""""""""""""""""""""""""""""""
15101510

15111511
.. module:: multiprocessing.sharedctypes
15121512
:synopsis: Allocate ctypes objects from shared memory.
@@ -1672,7 +1672,7 @@ The results printed are ::
16721672
.. _multiprocessing-managers:
16731673

16741674
Managers
1675-
~~~~~~~~
1675+
^^^^^^^^
16761676

16771677
Managers provide a way to create data which can be shared between different
16781678
processes, including sharing over a network between processes running on
@@ -1916,7 +1916,7 @@ their parent process exits. The manager classes are defined in the
19161916

19171917

19181918
Customized managers
1919-
>>>>>>>>>>>>>>>>>>>
1919+
"""""""""""""""""""
19201920

19211921
To create one's own manager, one creates a subclass of :class:`BaseManager` and
19221922
uses the :meth:`~BaseManager.register` classmethod to register new types or
@@ -1943,7 +1943,7 @@ callables with the manager class. For example::
19431943

19441944

19451945
Using a remote manager
1946-
>>>>>>>>>>>>>>>>>>>>>>
1946+
""""""""""""""""""""""
19471947

19481948
It is possible to run a manager server on one machine and have clients use it
19491949
from other machines (assuming that the firewalls involved allow it).
@@ -2006,7 +2006,7 @@ client to access it remotely::
20062006
.. _multiprocessing-proxy_objects:
20072007

20082008
Proxy Objects
2009-
~~~~~~~~~~~~~
2009+
^^^^^^^^^^^^^
20102010

20112011
A proxy is an object which *refers* to a shared object which lives (presumably)
20122012
in a different process. The shared object is said to be the *referent* of the
@@ -2158,7 +2158,7 @@ demonstrates a level of control over the synchronization.
21582158

21592159

21602160
Cleanup
2161-
>>>>>>>
2161+
"""""""
21622162

21632163
A proxy object uses a weakref callback so that when it gets garbage collected it
21642164
deregisters itself from the manager which owns its referent.
@@ -2168,7 +2168,7 @@ any proxies referring to it.
21682168

21692169

21702170
Process Pools
2171-
~~~~~~~~~~~~~
2171+
^^^^^^^^^^^^^
21722172

21732173
.. module:: multiprocessing.pool
21742174
:synopsis: Create pools of processes.
@@ -2400,7 +2400,7 @@ The following example demonstrates the use of a pool::
24002400
.. _multiprocessing-listeners-clients:
24012401

24022402
Listeners and Clients
2403-
~~~~~~~~~~~~~~~~~~~~~
2403+
^^^^^^^^^^^^^^^^^^^^^
24042404

24052405
.. module:: multiprocessing.connection
24062406
:synopsis: API for dealing with sockets.
@@ -2624,7 +2624,7 @@ wait for messages from multiple processes at once::
26242624
.. _multiprocessing-address-formats:
26252625

26262626
Address Formats
2627-
>>>>>>>>>>>>>>>
2627+
"""""""""""""""
26282628

26292629
* An ``'AF_INET'`` address is a tuple of the form ``(hostname, port)`` where
26302630
*hostname* is a string and *port* is an integer.
@@ -2644,7 +2644,7 @@ an ``'AF_PIPE'`` address rather than an ``'AF_UNIX'`` address.
26442644
.. _multiprocessing-auth-keys:
26452645

26462646
Authentication keys
2647-
~~~~~~~~~~~~~~~~~~~
2647+
^^^^^^^^^^^^^^^^^^^
26482648

26492649
When one uses :meth:`Connection.recv <Connection.recv>`, the
26502650
data received is automatically
@@ -2670,7 +2670,7 @@ Suitable authentication keys can also be generated by using :func:`os.urandom`.
26702670

26712671

26722672
Logging
2673-
~~~~~~~
2673+
^^^^^^^
26742674

26752675
Some support for logging is available. Note, however, that the :mod:`logging`
26762676
package does not use process shared locks so it is possible (depending on the
@@ -2718,7 +2718,7 @@ For a full table of logging levels, see the :mod:`logging` module.
27182718

27192719

27202720
The :mod:`multiprocessing.dummy` module
2721-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2721+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27222722

27232723
.. module:: multiprocessing.dummy
27242724
:synopsis: Dumb wrapper around threading.
@@ -2777,7 +2777,7 @@ There are certain guidelines and idioms which should be adhered to when using
27772777

27782778

27792779
All start methods
2780-
~~~~~~~~~~~~~~~~~
2780+
^^^^^^^^^^^^^^^^^
27812781

27822782
The following applies to all start methods.
27832783

@@ -2936,7 +2936,7 @@ Beware of replacing :data:`sys.stdin` with a "file like object"
29362936
For more information, see :issue:`5155`, :issue:`5313` and :issue:`5331`
29372937

29382938
The *spawn* and *forkserver* start methods
2939-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2939+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29402940

29412941
There are a few extra restriction which don't apply to the *fork*
29422942
start method.

0 commit comments

Comments
 (0)