[Python-checkins] r86254 - in python/branches/release27-maint/Doc/library: atexit.rst bisect.rst cmd.rst contextlib.rst dis.rst filecmp.rst fileinput.rst fnmatch.rst functools.rst glob.rst heapq.rst keyword.rst linecache.rst pprint.rst quopri.rst repr.rst sched.rst shelve.rst shutil.rst string.rst tokenize.rst trace.rst urlparse.rst uu.rst
raymond.hettinger
python-checkins at python.org
Sat Nov 6 08:10:32 CET 2010
Author: raymond.hettinger
Date: Sat Nov 6 08:10:31 2010
New Revision: 86254
Log:
Add more links to Python sources where the code is short, readable and an informative adjunct to the docs.
Modified:
python/branches/release27-maint/Doc/library/atexit.rst
python/branches/release27-maint/Doc/library/bisect.rst
python/branches/release27-maint/Doc/library/cmd.rst
python/branches/release27-maint/Doc/library/contextlib.rst
python/branches/release27-maint/Doc/library/dis.rst
python/branches/release27-maint/Doc/library/filecmp.rst
python/branches/release27-maint/Doc/library/fileinput.rst
python/branches/release27-maint/Doc/library/fnmatch.rst
python/branches/release27-maint/Doc/library/functools.rst
python/branches/release27-maint/Doc/library/glob.rst
python/branches/release27-maint/Doc/library/heapq.rst
python/branches/release27-maint/Doc/library/keyword.rst
python/branches/release27-maint/Doc/library/linecache.rst
python/branches/release27-maint/Doc/library/pprint.rst
python/branches/release27-maint/Doc/library/quopri.rst
python/branches/release27-maint/Doc/library/repr.rst
python/branches/release27-maint/Doc/library/sched.rst
python/branches/release27-maint/Doc/library/shelve.rst
python/branches/release27-maint/Doc/library/shutil.rst
python/branches/release27-maint/Doc/library/string.rst
python/branches/release27-maint/Doc/library/tokenize.rst
python/branches/release27-maint/Doc/library/trace.rst
python/branches/release27-maint/Doc/library/urlparse.rst
python/branches/release27-maint/Doc/library/uu.rst
Modified: python/branches/release27-maint/Doc/library/atexit.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/atexit.rst (original)
+++ python/branches/release27-maint/Doc/library/atexit.rst Sat Nov 6 08:10:31 2010
@@ -14,6 +14,11 @@
functions. Functions thus registered are automatically executed upon normal
interpreter termination.
+.. seealso::
+
+ Latest version of the `atexit Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/atexit.py?view=markup>`_
+
Note: the functions registered via this module are not called when the program
is killed by a signal, when a Python fatal internal error is detected, or when
:func:`os._exit` is called.
Modified: python/branches/release27-maint/Doc/library/bisect.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/bisect.rst (original)
+++ python/branches/release27-maint/Doc/library/bisect.rst Sat Nov 6 08:10:31 2010
@@ -16,6 +16,11 @@
.. versionadded:: 2.1
+.. seealso::
+
+ Latest version of the `bisect module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/bisect.py?view=markup>`_
+
The following functions are provided:
Modified: python/branches/release27-maint/Doc/library/cmd.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/cmd.rst (original)
+++ python/branches/release27-maint/Doc/library/cmd.rst Sat Nov 6 08:10:31 2010
@@ -12,6 +12,10 @@
tools, and prototypes that will later be wrapped in a more sophisticated
interface.
+.. seealso::
+
+ Latest version of the `cmd module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/cmd.py?view=markup>`_
.. class:: Cmd([completekey[, stdin[, stdout]]])
Modified: python/branches/release27-maint/Doc/library/contextlib.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/contextlib.rst (original)
+++ python/branches/release27-maint/Doc/library/contextlib.rst Sat Nov 6 08:10:31 2010
@@ -11,6 +11,11 @@
statement. For more information see also :ref:`typecontextmanager` and
:ref:`context-managers`.
+.. seealso::
+
+ Latest version of the `contextlib Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/contextlib.py?view=markup>`_
+
Functions provided:
Modified: python/branches/release27-maint/Doc/library/dis.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/dis.rst (original)
+++ python/branches/release27-maint/Doc/library/dis.rst Sat Nov 6 08:10:31 2010
@@ -11,6 +11,11 @@
input is defined in the file :file:`Include/opcode.h` and used by the compiler
and the interpreter.
+.. seealso::
+
+ Latest version of the `dis module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/dis.py?view=markup>`_
+
.. impl-detail::
Bytecode is an implementation detail of the CPython interpreter! No
Modified: python/branches/release27-maint/Doc/library/filecmp.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/filecmp.rst (original)
+++ python/branches/release27-maint/Doc/library/filecmp.rst Sat Nov 6 08:10:31 2010
@@ -11,6 +11,11 @@
with various optional time/correctness trade-offs. For comparing files,
see also the :mod:`difflib` module.
+.. seealso::
+
+ Latest version of the `filecmp Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/filecmp.py?view=markup>`_
+
The :mod:`filecmp` module defines the following functions:
Modified: python/branches/release27-maint/Doc/library/fileinput.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/fileinput.rst (original)
+++ python/branches/release27-maint/Doc/library/fileinput.rst Sat Nov 6 08:10:31 2010
@@ -44,6 +44,11 @@
returns an accordingly opened file-like object. Two useful hooks are already
provided by this module.
+.. seealso::
+
+ Latest version of the `fileinput Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/fileinput.py?view=markup>`_
+
The following function is the primary interface of this module:
Modified: python/branches/release27-maint/Doc/library/fnmatch.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/fnmatch.rst (original)
+++ python/branches/release27-maint/Doc/library/fnmatch.rst Sat Nov 6 08:10:31 2010
@@ -34,6 +34,10 @@
a period are not special for this module, and are matched by the ``*`` and ``?``
patterns.
+.. seealso::
+
+ Latest version of the `fnmatch Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/fnmatch.py?view=markup>`_
.. function:: fnmatch(filename, pattern)
Modified: python/branches/release27-maint/Doc/library/functools.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/functools.rst (original)
+++ python/branches/release27-maint/Doc/library/functools.rst Sat Nov 6 08:10:31 2010
@@ -15,6 +15,11 @@
or return other functions. In general, any callable object can be treated as a
function for the purposes of this module.
+.. seealso::
+
+ Latest version of the `functools Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/functools.py?view=markup>`_
+
The :mod:`functools` module defines the following functions:
.. function:: cmp_to_key(func)
Modified: python/branches/release27-maint/Doc/library/glob.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/glob.rst (original)
+++ python/branches/release27-maint/Doc/library/glob.rst Sat Nov 6 08:10:31 2010
@@ -16,6 +16,10 @@
subshell. (For tilde and shell variable expansion, use
:func:`os.path.expanduser` and :func:`os.path.expandvars`.)
+.. seealso::
+
+ Latest version of the `glob module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/glob.py?view=markup>`_
.. function:: glob(pathname)
Modified: python/branches/release27-maint/Doc/library/heapq.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/heapq.rst (original)
+++ python/branches/release27-maint/Doc/library/heapq.rst Sat Nov 6 08:10:31 2010
@@ -13,6 +13,11 @@
This module provides an implementation of the heap queue algorithm, also known
as the priority queue algorithm.
+.. seealso::
+
+ Latest version of the `heapq Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/heapq.py?view=markup>`_
+
Heaps are arrays for which ``heap[k] <= heap[2*k+1]`` and ``heap[k] <=
heap[2*k+2]`` for all *k*, counting elements from zero. For the sake of
comparison, non-existing elements are considered to be infinite. The
Modified: python/branches/release27-maint/Doc/library/keyword.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/keyword.rst (original)
+++ python/branches/release27-maint/Doc/library/keyword.rst Sat Nov 6 08:10:31 2010
@@ -20,3 +20,8 @@
keywords are defined to only be active when particular :mod:`__future__`
statements are in effect, these will be included as well.
+
+.. seealso::
+
+ Latest version of the `keyword module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/keyword.py?view=markup>`_
Modified: python/branches/release27-maint/Doc/library/linecache.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/linecache.rst (original)
+++ python/branches/release27-maint/Doc/library/linecache.rst Sat Nov 6 08:10:31 2010
@@ -12,6 +12,11 @@
lines are read from a single file. This is used by the :mod:`traceback` module
to retrieve source lines for inclusion in the formatted traceback.
+.. seealso::
+
+ Latest version of the `linecache module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/linecache.py?view=markup>`_
+
The :mod:`linecache` module defines the following functions:
Modified: python/branches/release27-maint/Doc/library/pprint.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/pprint.rst (original)
+++ python/branches/release27-maint/Doc/library/pprint.rst Sat Nov 6 08:10:31 2010
@@ -28,6 +28,11 @@
.. versionchanged:: 2.6
Added support for :class:`set` and :class:`frozenset`.
+.. seealso::
+
+ Latest version of the `pprint module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/pprint.py?view=markup>`_
+
The :mod:`pprint` module defines one class:
.. First the implementation class:
Modified: python/branches/release27-maint/Doc/library/quopri.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/quopri.rst (original)
+++ python/branches/release27-maint/Doc/library/quopri.rst Sat Nov 6 08:10:31 2010
@@ -18,6 +18,10 @@
:mod:`base64` module is more compact if there are many such characters, as when
sending a graphics file.
+.. seealso::
+
+ Latest version of the `quopri module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/quopri.py?view=markup>`_
.. function:: decode(input, output[,header])
Modified: python/branches/release27-maint/Doc/library/repr.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/repr.rst (original)
+++ python/branches/release27-maint/Doc/library/repr.rst Sat Nov 6 08:10:31 2010
@@ -15,6 +15,11 @@
with limits on the size of the resulting strings. This is used in the Python
debugger and may be useful in other contexts as well.
+.. seealso::
+
+ Latest version of the `repr module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/repr.py?view=markup>`_
+
This module provides a class, an instance, and a function:
Modified: python/branches/release27-maint/Doc/library/sched.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/sched.rst (original)
+++ python/branches/release27-maint/Doc/library/sched.rst Sat Nov 6 08:10:31 2010
@@ -10,6 +10,10 @@
The :mod:`sched` module defines a class which implements a general purpose event
scheduler:
+.. seealso::
+
+ Latest version of the `sched module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/sched.py?view=markup>`_
.. class:: scheduler(timefunc, delayfunc)
Modified: python/branches/release27-maint/Doc/library/shelve.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/shelve.rst (original)
+++ python/branches/release27-maint/Doc/library/shelve.rst Sat Nov 6 08:10:31 2010
@@ -13,6 +13,10 @@
This includes most class instances, recursive data types, and objects containing
lots of shared sub-objects. The keys are ordinary strings.
+.. seealso::
+
+ Latest version of the `shelve module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/shelve.py?view=markup>`_
.. function:: open(filename[, flag='c'[, protocol=None[, writeback=False]]])
Modified: python/branches/release27-maint/Doc/library/shutil.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/shutil.rst (original)
+++ python/branches/release27-maint/Doc/library/shutil.rst Sat Nov 6 08:10:31 2010
@@ -16,6 +16,11 @@
copying and removal. For operations on individual files, see also the
:mod:`os` module.
+.. seealso::
+
+ Latest version of the `shutil module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/shutil.py?view=markup>`_
+
.. warning::
Even the higher-level file copying functions (:func:`copy`, :func:`copy2`)
@@ -27,6 +32,7 @@
not be correct. On Windows, file owners, ACLs and alternate data streams
are not copied.
+
Directory and files operations
------------------------------
Modified: python/branches/release27-maint/Doc/library/string.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/string.rst (original)
+++ python/branches/release27-maint/Doc/library/string.rst Sat Nov 6 08:10:31 2010
@@ -17,6 +17,11 @@
:ref:`string-formatting` section. Also, see the :mod:`re` module for
string functions based on regular expressions.
+.. seealso::
+
+ Latest version of the `string module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/string.py?view=markup>`_
+
String constants
----------------
Modified: python/branches/release27-maint/Doc/library/tokenize.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/tokenize.rst (original)
+++ python/branches/release27-maint/Doc/library/tokenize.rst Sat Nov 6 08:10:31 2010
@@ -13,6 +13,11 @@
well, making it useful for implementing "pretty-printers," including colorizers
for on-screen displays.
+.. seealso::
+
+ Latest version of the `tokenize module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/tokenize.py?view=markup>`_
+
The primary entry point is a :term:`generator`:
.. function:: generate_tokens(readline)
Modified: python/branches/release27-maint/Doc/library/trace.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/trace.rst (original)
+++ python/branches/release27-maint/Doc/library/trace.rst Sat Nov 6 08:10:31 2010
@@ -11,6 +11,10 @@
list functions executed during a program run. It can be used in another program
or from the command line.
+.. seealso::
+
+ Latest version of the `trace module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/trace.py?view=markup>`_
.. _trace-cli:
Modified: python/branches/release27-maint/Doc/library/urlparse.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/urlparse.rst (original)
+++ python/branches/release27-maint/Doc/library/urlparse.rst Sat Nov 6 08:10:31 2010
@@ -33,6 +33,11 @@
.. versionadded:: 2.5
Support for the ``sftp`` and ``sips`` schemes.
+.. seealso::
+
+ Latest version of the `urlparse module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/urlparse.py?view=markup>`_
+
The :mod:`urlparse` module defines the following functions:
Modified: python/branches/release27-maint/Doc/library/uu.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/uu.rst (original)
+++ python/branches/release27-maint/Doc/library/uu.rst Sat Nov 6 08:10:31 2010
@@ -22,6 +22,11 @@
This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.
+.. seealso::
+
+ Latest version of the `uu module Python source code
+ <http://svn.python.org/view/python/branches/release27-maint/Lib/uu.py?view=markup>`_
+
The :mod:`uu` module defines the following functions:
More information about the Python-checkins
mailing list