[Python-checkins] r87901 - in python/branches/py3k/Doc: library/ast.rst library/bisect.rst library/calendar.rst library/cmd.rst library/collections.rst library/contextlib.rst library/dis.rst library/filecmp.rst library/fileinput.rst library/fnmatch.rst library/glob.rst library/heapq.rst library/keyword.rst library/linecache.rst library/pprint.rst library/queue.rst library/random.rst library/sched.rst library/shelve.rst library/shutil.rst library/string.rst library/textwrap.rst library/threading.rst library/tokenize.rst library/trace.rst library/uu.rst whatsnew/3.2.rst
raymond.hettinger
python-checkins at python.org
Mon Jan 10 20:54:11 CET 2011
Author: raymond.hettinger
Date: Mon Jan 10 20:54:11 2011
New Revision: 87901
Log:
Separate source link from main text.
Modified:
python/branches/py3k/Doc/library/ast.rst
python/branches/py3k/Doc/library/bisect.rst
python/branches/py3k/Doc/library/calendar.rst
python/branches/py3k/Doc/library/cmd.rst
python/branches/py3k/Doc/library/collections.rst
python/branches/py3k/Doc/library/contextlib.rst
python/branches/py3k/Doc/library/dis.rst
python/branches/py3k/Doc/library/filecmp.rst
python/branches/py3k/Doc/library/fileinput.rst
python/branches/py3k/Doc/library/fnmatch.rst
python/branches/py3k/Doc/library/glob.rst
python/branches/py3k/Doc/library/heapq.rst
python/branches/py3k/Doc/library/keyword.rst
python/branches/py3k/Doc/library/linecache.rst
python/branches/py3k/Doc/library/pprint.rst
python/branches/py3k/Doc/library/queue.rst
python/branches/py3k/Doc/library/random.rst
python/branches/py3k/Doc/library/sched.rst
python/branches/py3k/Doc/library/shelve.rst
python/branches/py3k/Doc/library/shutil.rst
python/branches/py3k/Doc/library/string.rst
python/branches/py3k/Doc/library/textwrap.rst
python/branches/py3k/Doc/library/threading.rst
python/branches/py3k/Doc/library/tokenize.rst
python/branches/py3k/Doc/library/trace.rst
python/branches/py3k/Doc/library/uu.rst
python/branches/py3k/Doc/whatsnew/3.2.rst
Modified: python/branches/py3k/Doc/library/ast.rst
==============================================================================
--- python/branches/py3k/Doc/library/ast.rst (original)
+++ python/branches/py3k/Doc/library/ast.rst Mon Jan 10 20:54:11 2011
@@ -9,6 +9,8 @@
**Source code:** :source:`Lib/ast.py`
+--------------
+
The :mod:`ast` module helps Python applications to process trees of the Python
abstract syntax grammar. The abstract syntax itself might change with each
Python release; this module helps to find out programmatically what the current
Modified: python/branches/py3k/Doc/library/bisect.rst
==============================================================================
--- python/branches/py3k/Doc/library/bisect.rst (original)
+++ python/branches/py3k/Doc/library/bisect.rst Mon Jan 10 20:54:11 2011
@@ -9,6 +9,8 @@
**Source code:** :source:`Lib/bisect.py`
+--------------
+
This module provides support for maintaining a list in sorted order without
having to sort the list after each insertion. For long lists of items with
expensive comparison operations, this can be an improvement over the more common
Modified: python/branches/py3k/Doc/library/calendar.rst
==============================================================================
--- python/branches/py3k/Doc/library/calendar.rst (original)
+++ python/branches/py3k/Doc/library/calendar.rst Mon Jan 10 20:54:11 2011
@@ -8,6 +8,8 @@
**Source code:** :source:`Lib/calendar.py`
+--------------
+
This module allows you to output calendars like the Unix :program:`cal` program,
and provides additional useful functions related to the calendar. By default,
these calendars have Monday as the first day of the week, and Sunday as the last
Modified: python/branches/py3k/Doc/library/cmd.rst
==============================================================================
--- python/branches/py3k/Doc/library/cmd.rst (original)
+++ python/branches/py3k/Doc/library/cmd.rst Mon Jan 10 20:54:11 2011
@@ -7,6 +7,8 @@
**Source code:** :source:`Lib/cmd.py`
+--------------
+
The :class:`Cmd` class provides a simple framework for writing line-oriented
command interpreters. These are often useful for test harnesses, administrative
tools, and prototypes that will later be wrapped in a more sophisticated
Modified: python/branches/py3k/Doc/library/collections.rst
==============================================================================
--- python/branches/py3k/Doc/library/collections.rst (original)
+++ python/branches/py3k/Doc/library/collections.rst Mon Jan 10 20:54:11 2011
@@ -14,6 +14,8 @@
**Source code:** :source:`Lib/collections.py`
+--------------
+
This module implements specialized container datatypes providing alternatives to
Python's general purpose built-in containers, :class:`dict`, :class:`list`,
:class:`set`, and :class:`tuple`.
Modified: python/branches/py3k/Doc/library/contextlib.rst
==============================================================================
--- python/branches/py3k/Doc/library/contextlib.rst (original)
+++ python/branches/py3k/Doc/library/contextlib.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/contextlib.py`
+--------------
+
This module provides utilities for common tasks involving the :keyword:`with`
statement. For more information see also :ref:`typecontextmanager` and
:ref:`context-managers`.
Modified: python/branches/py3k/Doc/library/dis.rst
==============================================================================
--- python/branches/py3k/Doc/library/dis.rst (original)
+++ python/branches/py3k/Doc/library/dis.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/dis.py`
+--------------
+
The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by
disassembling it. The CPython bytecode which this module takes as an
input is defined in the file :file:`Include/opcode.h` and used by the compiler
Modified: python/branches/py3k/Doc/library/filecmp.rst
==============================================================================
--- python/branches/py3k/Doc/library/filecmp.rst (original)
+++ python/branches/py3k/Doc/library/filecmp.rst Mon Jan 10 20:54:11 2011
@@ -7,6 +7,8 @@
**Source code:** :source:`Lib/filecmp.py`
+--------------
+
The :mod:`filecmp` module defines functions to compare files and directories,
with various optional time/correctness trade-offs. For comparing files,
see also the :mod:`difflib` module.
Modified: python/branches/py3k/Doc/library/fileinput.rst
==============================================================================
--- python/branches/py3k/Doc/library/fileinput.rst (original)
+++ python/branches/py3k/Doc/library/fileinput.rst Mon Jan 10 20:54:11 2011
@@ -8,6 +8,8 @@
**Source code:** :source:`Lib/fileinput.py`
+--------------
+
This module implements a helper class and functions to quickly write a
loop over standard input or a list of files. If you just want to read or
write one file see :func:`open`.
Modified: python/branches/py3k/Doc/library/fnmatch.rst
==============================================================================
--- python/branches/py3k/Doc/library/fnmatch.rst (original)
+++ python/branches/py3k/Doc/library/fnmatch.rst Mon Jan 10 20:54:11 2011
@@ -11,6 +11,8 @@
**Source code:** :source:`Lib/fnmatch.py`
+--------------
+
This module provides support for Unix shell-style wildcards, which are *not* the
same as regular expressions (which are documented in the :mod:`re` module). The
special characters used in shell-style wildcards are:
Modified: python/branches/py3k/Doc/library/glob.rst
==============================================================================
--- python/branches/py3k/Doc/library/glob.rst (original)
+++ python/branches/py3k/Doc/library/glob.rst Mon Jan 10 20:54:11 2011
@@ -9,6 +9,8 @@
**Source code:** :source:`Lib/glob.py`
+--------------
+
The :mod:`glob` module finds all the pathnames matching a specified pattern
according to the rules used by the Unix shell. No tilde expansion is done, but
``*``, ``?``, and character ranges expressed with ``[]`` will be correctly
Modified: python/branches/py3k/Doc/library/heapq.rst
==============================================================================
--- python/branches/py3k/Doc/library/heapq.rst (original)
+++ python/branches/py3k/Doc/library/heapq.rst Mon Jan 10 20:54:11 2011
@@ -10,6 +10,8 @@
**Source code:** :source:`Lib/heapq.py`
+--------------
+
This module provides an implementation of the heap queue algorithm, also known
as the priority queue algorithm.
Modified: python/branches/py3k/Doc/library/keyword.rst
==============================================================================
--- python/branches/py3k/Doc/library/keyword.rst (original)
+++ python/branches/py3k/Doc/library/keyword.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/keyword.py`
+--------------
+
This module allows a Python program to determine if a string is a keyword.
Modified: python/branches/py3k/Doc/library/linecache.rst
==============================================================================
--- python/branches/py3k/Doc/library/linecache.rst (original)
+++ python/branches/py3k/Doc/library/linecache.rst Mon Jan 10 20:54:11 2011
@@ -7,6 +7,8 @@
**Source code:** :source:`Lib/linecache.py`
+--------------
+
The :mod:`linecache` module allows one to get any line from any file, while
attempting to optimize internally, using a cache, the common case where many
lines are read from a single file. This is used by the :mod:`traceback` module
Modified: python/branches/py3k/Doc/library/pprint.rst
==============================================================================
--- python/branches/py3k/Doc/library/pprint.rst (original)
+++ python/branches/py3k/Doc/library/pprint.rst Mon Jan 10 20:54:11 2011
@@ -8,6 +8,8 @@
**Source code:** :source:`Lib/pprint.py`
+--------------
+
The :mod:`pprint` module provides a capability to "pretty-print" arbitrary
Python data structures in a form which can be used as input to the interpreter.
If the formatted structures include objects which are not fundamental Python
Modified: python/branches/py3k/Doc/library/queue.rst
==============================================================================
--- python/branches/py3k/Doc/library/queue.rst (original)
+++ python/branches/py3k/Doc/library/queue.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/queue.py`
+--------------
+
The :mod:`queue` module implements multi-producer, multi-consumer queues.
It is especially useful in threaded programming when information must be
exchanged safely between multiple threads. The :class:`Queue` class in this
Modified: python/branches/py3k/Doc/library/random.rst
==============================================================================
--- python/branches/py3k/Doc/library/random.rst (original)
+++ python/branches/py3k/Doc/library/random.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/random.py`
+--------------
+
This module implements pseudo-random number generators for various
distributions.
Modified: python/branches/py3k/Doc/library/sched.rst
==============================================================================
--- python/branches/py3k/Doc/library/sched.rst (original)
+++ python/branches/py3k/Doc/library/sched.rst Mon Jan 10 20:54:11 2011
@@ -9,6 +9,8 @@
**Source code:** :source:`Lib/sched.py`
+--------------
+
The :mod:`sched` module defines a class which implements a general purpose event
scheduler:
Modified: python/branches/py3k/Doc/library/shelve.rst
==============================================================================
--- python/branches/py3k/Doc/library/shelve.rst (original)
+++ python/branches/py3k/Doc/library/shelve.rst Mon Jan 10 20:54:11 2011
@@ -9,6 +9,8 @@
**Source code:** :source:`Lib/shelve.py`
+--------------
+
A "shelf" is a persistent, dictionary-like object. The difference with "dbm"
databases is that the values (not the keys!) in a shelf can be essentially
arbitrary Python objects --- anything that the :mod:`pickle` module can handle.
Modified: python/branches/py3k/Doc/library/shutil.rst
==============================================================================
--- python/branches/py3k/Doc/library/shutil.rst (original)
+++ python/branches/py3k/Doc/library/shutil.rst Mon Jan 10 20:54:11 2011
@@ -12,6 +12,8 @@
**Source code:** :source:`Lib/shutil.py`
+--------------
+
The :mod:`shutil` module offers a number of high-level operations on files and
collections of files. In particular, functions are provided which support file
copying and removal. For operations on individual files, see also the
Modified: python/branches/py3k/Doc/library/string.rst
==============================================================================
--- python/branches/py3k/Doc/library/string.rst (original)
+++ python/branches/py3k/Doc/library/string.rst Mon Jan 10 20:54:11 2011
@@ -13,6 +13,8 @@
**Source code:** :source:`Lib/string.py`
+--------------
+
String constants
----------------
Modified: python/branches/py3k/Doc/library/textwrap.rst
==============================================================================
--- python/branches/py3k/Doc/library/textwrap.rst (original)
+++ python/branches/py3k/Doc/library/textwrap.rst Mon Jan 10 20:54:11 2011
@@ -8,6 +8,8 @@
**Source code:** :source:`Lib/textwrap.py`
+--------------
+
The :mod:`textwrap` module provides two convenience functions, :func:`wrap` and
:func:`fill`, as well as :class:`TextWrapper`, the class that does all the work,
and a utility function :func:`dedent`. If you're just wrapping or filling one
Modified: python/branches/py3k/Doc/library/threading.rst
==============================================================================
--- python/branches/py3k/Doc/library/threading.rst (original)
+++ python/branches/py3k/Doc/library/threading.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/threading.py`
+--------------
+
This module constructs higher-level threading interfaces on top of the lower
level :mod:`_thread` module. See also the :mod:`queue` module.
Modified: python/branches/py3k/Doc/library/tokenize.rst
==============================================================================
--- python/branches/py3k/Doc/library/tokenize.rst (original)
+++ python/branches/py3k/Doc/library/tokenize.rst Mon Jan 10 20:54:11 2011
@@ -8,6 +8,8 @@
**Source code:** :source:`Lib/tokenize.py`
+--------------
+
The :mod:`tokenize` module provides a lexical scanner for Python source code,
implemented in Python. The scanner in this module returns comments as tokens
as well, making it useful for implementing "pretty-printers," including
Modified: python/branches/py3k/Doc/library/trace.rst
==============================================================================
--- python/branches/py3k/Doc/library/trace.rst (original)
+++ python/branches/py3k/Doc/library/trace.rst Mon Jan 10 20:54:11 2011
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/trace.py`
+--------------
+
The :mod:`trace` module allows you to trace program execution, generate
annotated statement coverage listings, print caller/callee relationships and
list functions executed during a program run. It can be used in another program
Modified: python/branches/py3k/Doc/library/uu.rst
==============================================================================
--- python/branches/py3k/Doc/library/uu.rst (original)
+++ python/branches/py3k/Doc/library/uu.rst Mon Jan 10 20:54:11 2011
@@ -7,6 +7,8 @@
**Source code:** :source:`Lib/uu.py`
+--------------
+
This module encodes and decodes files in uuencode format, allowing arbitrary
binary data to be transferred over ASCII-only connections. Wherever a file
argument is expected, the methods accept a file-like object. For backwards
Modified: python/branches/py3k/Doc/whatsnew/3.2.rst
==============================================================================
--- python/branches/py3k/Doc/whatsnew/3.2.rst (original)
+++ python/branches/py3k/Doc/whatsnew/3.2.rst Mon Jan 10 20:54:11 2011
@@ -1614,7 +1614,7 @@
In some cases, the pure Python source code can be helpful adjunct to the docs,
so now some modules feature quick links to the latest version of the source
code. For example, the :mod:`functools` module documentation has a quick link
-at the top labeled *Source code* source:`Lib/functools.py`.
+at the top labeled: *Source code* :source:`Lib/functools.py`.
The docs now contain more examples and recipes. In particular, :mod:`re` module
has an extensive section, :ref:`re-examples`. Likewise, the :mod:`itertools`
More information about the Python-checkins
mailing list