Skip to content

Commit fa089b9

Browse files
committed
Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format. Patch by Yoni Lavi.
1 parent c92bf83 commit fa089b9

File tree

224 files changed

+539
-136
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+539
-136
lines changed

Doc/library/2to3.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,10 +449,14 @@ and off individually. They are described here in more detail.
449449

450450
.. module:: lib2to3
451451
:synopsis: the 2to3 library
452+
452453
.. moduleauthor:: Guido van Rossum
453454
.. moduleauthor:: Collin Winter
454455
.. moduleauthor:: Benjamin Peterson <[email protected]>
455456

457+
**Source code:** :source:`Lib/lib2to3/`
458+
459+
--------------
456460

457461
.. note::
458462

Doc/library/__main__.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
.. module:: __main__
66
:synopsis: The environment where the top-level script is run.
77

8+
--------------
9+
810
``'__main__'`` is the name of the scope in which top-level code executes.
911
A module's __name__ is set equal to ``'__main__'`` when read from
1012
standard input, a script, or from an interactive prompt.

Doc/library/_thread.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
.. module:: _thread
55
:synopsis: Low-level threading API.
66

7-
87
.. index::
98
single: light-weight processes
109
single: processes, light-weight
1110
single: binary semaphores
1211
single: semaphores, binary
1312

13+
--------------
14+
1415
This module provides low-level primitives for working with multiple threads
1516
(also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of
1617
control sharing their global data space. For synchronization, simple locks

Doc/library/abc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: abc
55
:synopsis: Abstract base classes according to PEP 3119.
6+
67
.. moduleauthor:: Guido van Rossum
78
.. sectionauthor:: Georg Brandl
89
.. much of the content adapted from docstrings

Doc/library/aifc.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
.. module:: aifc
55
:synopsis: Read and write audio files in AIFF or AIFC format.
66

7+
**Source code:** :source:`Lib/aifc.py`
78

89
.. index::
910
single: Audio Interchange File Format
1011
single: AIFF
1112
single: AIFF-C
1213

13-
**Source code:** :source:`Lib/aifc.py`
14-
1514
--------------
1615

1716
This module provides support for reading and writing AIFF and AIFF-C files.

Doc/library/argparse.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: argparse
55
:synopsis: Command-line option and argument parsing library.
6+
67
.. moduleauthor:: Steven Bethard <[email protected]>
78
.. sectionauthor:: Steven Bethard <[email protected]>
89

Doc/library/array.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
.. module:: array
55
:synopsis: Space efficient arrays of uniformly typed numeric values.
66

7-
87
.. index:: single: arrays
98

9+
--------------
10+
1011
This module defines an object type which can compactly represent an array of
1112
basic values: characters, integers, floating point numbers. Arrays are sequence
1213
types and behave very much like lists, except that the type of objects stored in

Doc/library/asynchat.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: asynchat
55
:synopsis: Support for asynchronous command/response protocols.
6+
67
.. moduleauthor:: Sam Rushing <[email protected]>
78
.. sectionauthor:: Steve Holden <[email protected]>
89

Doc/library/asyncio.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
.. module:: asyncio
55
:synopsis: Asynchronous I/O, event loop, coroutines and tasks.
66

7+
.. versionadded:: 3.4
8+
9+
**Source code:** :source:`Lib/asyncio/`
10+
711
.. note::
812

913
The asyncio package has been included in the standard library on a
1014
:term:`provisional basis <provisional package>`. Backwards incompatible
1115
changes (up to and including removal of the module) may occur if deemed
1216
necessary by the core developers.
1317

14-
.. versionadded:: 3.4
15-
16-
**Source code:** :source:`Lib/asyncio/`
17-
1818
--------------
1919

2020
This module provides infrastructure for writing single-threaded concurrent

Doc/library/asyncore.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: asyncore
55
:synopsis: A base class for developing asynchronous socket handling
66
services.
7+
78
.. moduleauthor:: Sam Rushing <[email protected]>
89
.. sectionauthor:: Christopher Petrilli <[email protected]>
910
.. sectionauthor:: Steve Holden <[email protected]>

Doc/library/atexit.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33

44
.. module:: atexit
55
:synopsis: Register and execute cleanup functions.
6+
67
.. moduleauthor:: Skip Montanaro <[email protected]>
78
.. sectionauthor:: Skip Montanaro <[email protected]>
89

10+
--------------
911

1012
The :mod:`atexit` module defines functions to register and unregister cleanup
1113
functions. Functions thus registered are automatically executed upon normal

Doc/library/audioop.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: audioop
55
:synopsis: Manipulate raw audio data.
66

7+
--------------
78

89
The :mod:`audioop` module contains some useful operations on sound fragments.
910
It operates on sound fragments consisting of signed integer samples 8, 16, 24

Doc/library/base64.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@
55
:synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings;
66
Base85 and Ascii85
77

8+
**Source code:** :source:`Lib/base64.py`
89

910
.. index::
1011
pair: base64; encoding
1112
single: MIME; base64 encoding
1213

14+
--------------
15+
1316
This module provides functions for encoding binary data to printable
1417
ASCII characters and decoding such encodings back to binary data.
1518
It provides encoding and decoding functions for the encodings specified in

Doc/library/binascii.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
:synopsis: Tools for converting between binary and various ASCII-encoded binary
66
representations.
77

8-
98
.. index::
109
module: uu
1110
module: base64
1211
module: binhex
1312

13+
--------------
14+
1415
The :mod:`binascii` module contains a number of methods to convert between
1516
binary and various ASCII-encoded binary representations. Normally, you will not
1617
use these functions directly but use wrapper modules like :mod:`uu`,

Doc/library/binhex.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
.. module:: binhex
55
:synopsis: Encode and decode files in binhex4 format.
66

7+
**Source code:** :source:`Lib/binhex.py`
8+
9+
--------------
710

811
This module encodes and decodes files in binhex4 format, a format allowing
912
representation of Macintosh files in ASCII. Only the data fork is handled.

Doc/library/builtins.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: builtins
55
:synopsis: The module that provides the built-in namespace.
66

7+
--------------
78

89
This module provides direct access to all 'built-in' identifiers of Python; for
910
example, ``builtins.open`` is the full name for the built-in function

Doc/library/bz2.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33

44
.. module:: bz2
55
:synopsis: Interfaces for bzip2 compression and decompression.
6+
67
.. moduleauthor:: Gustavo Niemeyer <[email protected]>
78
.. moduleauthor:: Nadeem Vawda <[email protected]>
89
.. sectionauthor:: Gustavo Niemeyer <[email protected]>
910
.. sectionauthor:: Nadeem Vawda <[email protected]>
1011

12+
**Source code:** :source:`Lib/bz2.py`
13+
14+
--------------
1115

1216
This module provides a comprehensive interface for compressing and
1317
decompressing data using the bzip2 compression algorithm.

Doc/library/calendar.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: calendar
55
:synopsis: Functions for working with calendars, including some emulation
66
of the Unix cal program.
7+
78
.. sectionauthor:: Drew Csillag <[email protected]>
89

910
**Source code:** :source:`Lib/calendar.py`

Doc/library/cgi.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: cgi
55
:synopsis: Helpers for running Python scripts via the Common Gateway Interface.
66

7+
**Source code:** :source:`Lib/cgi.py`
78

89
.. index::
910
pair: WWW; server
@@ -13,8 +14,6 @@
1314
single: URL
1415
single: Common Gateway Interface
1516

16-
**Source code:** :source:`Lib/cgi.py`
17-
1817
--------------
1918

2019
Support module for Common Gateway Interface (CGI) scripts.

Doc/library/cgitb.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@
33

44
.. module:: cgitb
55
:synopsis: Configurable traceback handler for CGI scripts.
6+
67
.. moduleauthor:: Ka-Ping Yee <[email protected]>
78
.. sectionauthor:: Fred L. Drake, Jr. <[email protected]>
89

10+
**Source code:** :source:`Lib/cgitb.py`
911

1012
.. index::
1113
single: CGI; exceptions
1214
single: CGI; tracebacks
1315
single: exceptions; in CGI scripts
1416
single: tracebacks; in CGI scripts
1517

18+
--------------
19+
1620
The :mod:`cgitb` module provides a special exception handler for Python scripts.
1721
(Its name is a bit misleading. It was originally designed to display extensive
1822
traceback information in HTML for CGI scripts. It was later generalized to also

Doc/library/chunk.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33

44
.. module:: chunk
55
:synopsis: Module to read IFF chunks.
6+
67
.. moduleauthor:: Sjoerd Mullender <[email protected]>
78
.. sectionauthor:: Sjoerd Mullender <[email protected]>
89

10+
**Source code:** :source:`Lib/chunk.py`
911

1012
.. index::
1113
single: Audio Interchange File Format
@@ -14,6 +16,8 @@
1416
single: Real Media File Format
1517
single: RMFF
1618

19+
--------------
20+
1721
This module provides an interface for reading files that use EA IFF 85 chunks.
1822
[#]_ This format is used in at least the Audio Interchange File Format
1923
(AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format

Doc/library/cmath.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: cmath
55
:synopsis: Mathematical functions for complex numbers.
66

7+
--------------
78

89
This module is always available. It provides access to mathematical functions
910
for complex numbers. The functions in this module accept integers,

Doc/library/cmd.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: cmd
55
:synopsis: Build line-oriented command interpreters.
6+
67
.. sectionauthor:: Eric S. Raymond <[email protected]>
78

89
**Source code:** :source:`Lib/cmd.py`

Doc/library/code.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
**Source code:** :source:`Lib/code.py`
88

9+
--------------
10+
911
The ``code`` module provides facilities to implement read-eval-print loops in
1012
Python. Two classes and convenience functions are included which can be used to
1113
build applications which provide an interactive interpreter prompt.

Doc/library/codecs.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: codecs
55
:synopsis: Encode and decode data and streams.
6+
67
.. moduleauthor:: Marc-André Lemburg <[email protected]>
78
.. sectionauthor:: Marc-André Lemburg <[email protected]>
89
.. sectionauthor:: Martin v. Löwis <[email protected]>
@@ -17,6 +18,8 @@
1718
single: streams
1819
pair: stackable; streams
1920

21+
--------------
22+
2023
This module defines base classes for standard Python codecs (encoders and
2124
decoders) and provides access to the internal Python codec registry, which
2225
manages the codec and error handling lookup process. Most standard codecs

Doc/library/codeop.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@
33

44
.. module:: codeop
55
:synopsis: Compile (possibly incomplete) Python code.
6+
67
.. sectionauthor:: Moshe Zadka <[email protected]>
78
.. sectionauthor:: Michael Hudson <[email protected]>
89

10+
**Source code:** :source:`Lib/codeop.py`
11+
12+
--------------
13+
914
The :mod:`codeop` module provides utilities upon which the Python
1015
read-eval-print loop can be emulated, as is done in the :mod:`code` module. As
1116
a result, you probably don't want to use the module directly; if you want to

Doc/library/collections.abc.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,21 @@
33

44
.. module:: collections.abc
55
:synopsis: Abstract base classes for containers
6+
67
.. moduleauthor:: Raymond Hettinger <python at rcn.com>
78
.. sectionauthor:: Raymond Hettinger <python at rcn.com>
89

910
.. versionadded:: 3.3
1011
Formerly, this module was part of the :mod:`collections` module.
1112

13+
**Source code:** :source:`Lib/_collections_abc.py`
14+
1215
.. testsetup:: *
1316

1417
from collections import *
1518
import itertools
1619
__name__ = '<doctest>'
1720

18-
**Source code:** :source:`Lib/_collections_abc.py`
19-
2021
--------------
2122

2223
This module provides :term:`abstract base classes <abstract base class>` that

Doc/library/collections.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,18 @@
33

44
.. module:: collections
55
:synopsis: Container datatypes
6+
67
.. moduleauthor:: Raymond Hettinger <[email protected]>
78
.. sectionauthor:: Raymond Hettinger <[email protected]>
89

10+
**Source code:** :source:`Lib/collections/__init__.py`
11+
912
.. testsetup:: *
1013

1114
from collections import *
1215
import itertools
1316
__name__ = '<doctest>'
1417

15-
**Source code:** :source:`Lib/collections/__init__.py`
16-
1718
--------------
1819

1920
This module implements specialized container datatypes providing alternatives to

Doc/library/colorsys.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: colorsys
55
:synopsis: Conversion functions between RGB and other color systems.
6+
67
.. sectionauthor:: David Ascher <[email protected]>
78

89
**Source code:** :source:`Lib/colorsys.py`

Doc/library/compileall.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
--------------
1010

11-
1211
This module provides some utility functions to support installing Python
1312
libraries. These functions compile Python source files in a directory tree.
1413
This module can be used to create the cached byte-code files at library

Doc/library/configparser.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
single: ini file
2020
single: Windows ini file
2121

22+
--------------
23+
2224
This module provides the :class:`ConfigParser` class which implements a basic
2325
configuration language which provides a structure similar to what's found in
2426
Microsoft Windows INI files. You can use this to write Python programs which

0 commit comments

Comments
 (0)