[Python-checkins] r72742 - in python/branches/py3k/Doc/library: abc.rst allos.rst archiving.rst array.rst asynchat.rst asyncore.rst atexit.rst audioop.rst base64.rst binascii.rst code.rst codeop.rst collections.rst compileall.rst contextlib.rst copy.rst copyreg.rst crypt.rst crypto.rst csv.rst ctypes.rst curses.ascii.rst curses.panel.rst curses.rst custominterp.rst datatypes.rst decimal.rst development.rst dis.rst distutils.rst errno.rst fcntl.rst filecmp.rst fileformats.rst fileinput.rst filesys.rst fnmatch.rst formatter.rst fpectl.rst
georg.brandl
python-checkins at python.org
Sun May 17 14:29:12 CEST 2009
Author: georg.brandl
Date: Sun May 17 14:29:12 2009
New Revision: 72742
Log:
Remove surplus empty lines and convert more files to new optional arg style.
Modified:
python/branches/py3k/Doc/library/abc.rst
python/branches/py3k/Doc/library/allos.rst
python/branches/py3k/Doc/library/archiving.rst
python/branches/py3k/Doc/library/array.rst
python/branches/py3k/Doc/library/asynchat.rst
python/branches/py3k/Doc/library/asyncore.rst
python/branches/py3k/Doc/library/atexit.rst
python/branches/py3k/Doc/library/audioop.rst
python/branches/py3k/Doc/library/base64.rst
python/branches/py3k/Doc/library/binascii.rst
python/branches/py3k/Doc/library/code.rst
python/branches/py3k/Doc/library/codeop.rst
python/branches/py3k/Doc/library/collections.rst
python/branches/py3k/Doc/library/compileall.rst
python/branches/py3k/Doc/library/contextlib.rst
python/branches/py3k/Doc/library/copy.rst
python/branches/py3k/Doc/library/copyreg.rst
python/branches/py3k/Doc/library/crypt.rst
python/branches/py3k/Doc/library/crypto.rst
python/branches/py3k/Doc/library/csv.rst
python/branches/py3k/Doc/library/ctypes.rst
python/branches/py3k/Doc/library/curses.ascii.rst
python/branches/py3k/Doc/library/curses.panel.rst
python/branches/py3k/Doc/library/curses.rst
python/branches/py3k/Doc/library/custominterp.rst
python/branches/py3k/Doc/library/datatypes.rst
python/branches/py3k/Doc/library/decimal.rst
python/branches/py3k/Doc/library/development.rst
python/branches/py3k/Doc/library/dis.rst
python/branches/py3k/Doc/library/distutils.rst
python/branches/py3k/Doc/library/errno.rst
python/branches/py3k/Doc/library/fcntl.rst
python/branches/py3k/Doc/library/filecmp.rst
python/branches/py3k/Doc/library/fileformats.rst
python/branches/py3k/Doc/library/fileinput.rst
python/branches/py3k/Doc/library/filesys.rst
python/branches/py3k/Doc/library/fnmatch.rst
python/branches/py3k/Doc/library/formatter.rst
python/branches/py3k/Doc/library/fpectl.rst
Modified: python/branches/py3k/Doc/library/abc.rst
==============================================================================
--- python/branches/py3k/Doc/library/abc.rst (original)
+++ python/branches/py3k/Doc/library/abc.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`abc` --- Abstract Base Classes
====================================
Modified: python/branches/py3k/Doc/library/allos.rst
==============================================================================
--- python/branches/py3k/Doc/library/allos.rst (original)
+++ python/branches/py3k/Doc/library/allos.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _allos:
*********************************
Modified: python/branches/py3k/Doc/library/archiving.rst
==============================================================================
--- python/branches/py3k/Doc/library/archiving.rst (original)
+++ python/branches/py3k/Doc/library/archiving.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _archiving:
******************************
Modified: python/branches/py3k/Doc/library/array.rst
==============================================================================
--- python/branches/py3k/Doc/library/array.rst (original)
+++ python/branches/py3k/Doc/library/array.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`array` --- Efficient arrays of numeric values
===================================================
Modified: python/branches/py3k/Doc/library/asynchat.rst
==============================================================================
--- python/branches/py3k/Doc/library/asynchat.rst (original)
+++ python/branches/py3k/Doc/library/asynchat.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`asynchat` --- Asynchronous socket command/response handler
================================================================
Modified: python/branches/py3k/Doc/library/asyncore.rst
==============================================================================
--- python/branches/py3k/Doc/library/asyncore.rst (original)
+++ python/branches/py3k/Doc/library/asyncore.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`asyncore` --- Asynchronous socket handler
===============================================
Modified: python/branches/py3k/Doc/library/atexit.rst
==============================================================================
--- python/branches/py3k/Doc/library/atexit.rst (original)
+++ python/branches/py3k/Doc/library/atexit.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`atexit` --- Exit handlers
===============================
Modified: python/branches/py3k/Doc/library/audioop.rst
==============================================================================
--- python/branches/py3k/Doc/library/audioop.rst (original)
+++ python/branches/py3k/Doc/library/audioop.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`audioop` --- Manipulate raw audio data
============================================
Modified: python/branches/py3k/Doc/library/base64.rst
==============================================================================
--- python/branches/py3k/Doc/library/base64.rst (original)
+++ python/branches/py3k/Doc/library/base64.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`base64` --- RFC 3548: Base16, Base32, Base64 Data Encodings
=================================================================
Modified: python/branches/py3k/Doc/library/binascii.rst
==============================================================================
--- python/branches/py3k/Doc/library/binascii.rst (original)
+++ python/branches/py3k/Doc/library/binascii.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`binascii` --- Convert between binary and ASCII
====================================================
Modified: python/branches/py3k/Doc/library/code.rst
==============================================================================
--- python/branches/py3k/Doc/library/code.rst (original)
+++ python/branches/py3k/Doc/library/code.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`code` --- Interpreter base classes
========================================
@@ -6,7 +5,6 @@
:synopsis: Facilities to implement read-eval-print loops.
-
The ``code`` module provides facilities to implement read-eval-print loops in
Python. Two classes and convenience functions are included which can be used to
build applications which provide an interactive interpreter prompt.
Modified: python/branches/py3k/Doc/library/codeop.rst
==============================================================================
--- python/branches/py3k/Doc/library/codeop.rst (original)
+++ python/branches/py3k/Doc/library/codeop.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`codeop` --- Compile Python code
=====================================
Modified: python/branches/py3k/Doc/library/collections.rst
==============================================================================
--- python/branches/py3k/Doc/library/collections.rst (original)
+++ python/branches/py3k/Doc/library/collections.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`collections` --- Container datatypes
==========================================
Modified: python/branches/py3k/Doc/library/compileall.rst
==============================================================================
--- python/branches/py3k/Doc/library/compileall.rst (original)
+++ python/branches/py3k/Doc/library/compileall.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`compileall` --- Byte-compile Python libraries
===================================================
Modified: python/branches/py3k/Doc/library/contextlib.rst
==============================================================================
--- python/branches/py3k/Doc/library/contextlib.rst (original)
+++ python/branches/py3k/Doc/library/contextlib.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`contextlib` --- Utilities for :keyword:`with`\ -statement contexts.
=========================================================================
Modified: python/branches/py3k/Doc/library/copy.rst
==============================================================================
--- python/branches/py3k/Doc/library/copy.rst (original)
+++ python/branches/py3k/Doc/library/copy.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`copy` --- Shallow and deep copy operations
================================================
Modified: python/branches/py3k/Doc/library/copyreg.rst
==============================================================================
--- python/branches/py3k/Doc/library/copyreg.rst (original)
+++ python/branches/py3k/Doc/library/copyreg.rst Sun May 17 14:29:12 2009
@@ -1,6 +1,5 @@
-
:mod:`copyreg` --- Register :mod:`pickle` support functions
-============================================================
+===========================================================
.. module:: copyreg
:synopsis: Register pickle support functions.
Modified: python/branches/py3k/Doc/library/crypt.rst
==============================================================================
--- python/branches/py3k/Doc/library/crypt.rst (original)
+++ python/branches/py3k/Doc/library/crypt.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`crypt` --- Function to check Unix passwords
=================================================
Modified: python/branches/py3k/Doc/library/crypto.rst
==============================================================================
--- python/branches/py3k/Doc/library/crypto.rst (original)
+++ python/branches/py3k/Doc/library/crypto.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _crypto:
**********************
Modified: python/branches/py3k/Doc/library/csv.rst
==============================================================================
--- python/branches/py3k/Doc/library/csv.rst (original)
+++ python/branches/py3k/Doc/library/csv.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`csv` --- CSV File Reading and Writing
===========================================
Modified: python/branches/py3k/Doc/library/ctypes.rst
==============================================================================
--- python/branches/py3k/Doc/library/ctypes.rst (original)
+++ python/branches/py3k/Doc/library/ctypes.rst Sun May 17 14:29:12 2009
@@ -1,6 +1,5 @@
-
-:mod:`ctypes` --- A foreign function library for Python.
-========================================================
+:mod:`ctypes` --- A foreign function library for Python
+=======================================================
.. module:: ctypes
:synopsis: A foreign function library for Python.
Modified: python/branches/py3k/Doc/library/curses.ascii.rst
==============================================================================
--- python/branches/py3k/Doc/library/curses.ascii.rst (original)
+++ python/branches/py3k/Doc/library/curses.ascii.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`curses.ascii` --- Utilities for ASCII characters
======================================================
Modified: python/branches/py3k/Doc/library/curses.panel.rst
==============================================================================
--- python/branches/py3k/Doc/library/curses.panel.rst (original)
+++ python/branches/py3k/Doc/library/curses.panel.rst Sun May 17 14:29:12 2009
@@ -1,6 +1,5 @@
-
-:mod:`curses.panel` --- A panel stack extension for curses.
-===========================================================
+:mod:`curses.panel` --- A panel stack extension for curses
+==========================================================
.. module:: curses.panel
:synopsis: A panel stack extension that adds depth to curses windows.
Modified: python/branches/py3k/Doc/library/curses.rst
==============================================================================
--- python/branches/py3k/Doc/library/curses.rst (original)
+++ python/branches/py3k/Doc/library/curses.rst Sun May 17 14:29:12 2009
@@ -1,9 +1,9 @@
-
:mod:`curses` --- Terminal handling for character-cell displays
===============================================================
.. module:: curses
- :synopsis: An interface to the curses library, providing portable terminal handling.
+ :synopsis: An interface to the curses library, providing portable
+ terminal handling.
.. sectionauthor:: Moshe Zadka <moshez at zadka.site.co.il>
.. sectionauthor:: Eric Raymond <esr at thyrsus.com>
Modified: python/branches/py3k/Doc/library/custominterp.rst
==============================================================================
--- python/branches/py3k/Doc/library/custominterp.rst (original)
+++ python/branches/py3k/Doc/library/custominterp.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _custominterp:
**************************
Modified: python/branches/py3k/Doc/library/datatypes.rst
==============================================================================
--- python/branches/py3k/Doc/library/datatypes.rst (original)
+++ python/branches/py3k/Doc/library/datatypes.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _datatypes:
**********
Modified: python/branches/py3k/Doc/library/decimal.rst
==============================================================================
--- python/branches/py3k/Doc/library/decimal.rst (original)
+++ python/branches/py3k/Doc/library/decimal.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`decimal` --- Decimal fixed point and floating point arithmetic
====================================================================
Modified: python/branches/py3k/Doc/library/development.rst
==============================================================================
--- python/branches/py3k/Doc/library/development.rst (original)
+++ python/branches/py3k/Doc/library/development.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _development:
*****************
Modified: python/branches/py3k/Doc/library/dis.rst
==============================================================================
--- python/branches/py3k/Doc/library/dis.rst (original)
+++ python/branches/py3k/Doc/library/dis.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`dis` --- Disassembler for Python bytecode
===============================================
@@ -6,11 +5,11 @@
:synopsis: Disassembler for Python bytecode.
-The :mod:`dis` module supports the analysis of Python :term:`bytecode` by disassembling
-it. Since there is no Python assembler, this module defines the Python assembly
-language. The Python bytecode which this module takes as an input is defined
-in the file :file:`Include/opcode.h` and used by the compiler and the
-interpreter.
+The :mod:`dis` module supports the analysis of Python :term:`bytecode` by
+disassembling it. Since there is no Python assembler, this module defines the
+Python assembly language. The Python bytecode which this module takes as an
+input is defined in the file :file:`Include/opcode.h` and used by the compiler
+and the interpreter.
Example: Given the function :func:`myfunc`::
Modified: python/branches/py3k/Doc/library/distutils.rst
==============================================================================
--- python/branches/py3k/Doc/library/distutils.rst (original)
+++ python/branches/py3k/Doc/library/distutils.rst Sun May 17 14:29:12 2009
@@ -1,10 +1,9 @@
-
:mod:`distutils` --- Building and installing Python modules
===========================================================
.. module:: distutils
- :synopsis: Support for building and installing Python modules into an existing Python
- installation.
+ :synopsis: Support for building and installing Python modules into an
+ existing Python installation.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
@@ -19,12 +18,12 @@
.. seealso::
:ref:`distutils-index`
- The manual for developers and packagers of Python modules. This describes how
- to prepare :mod:`distutils`\ -based packages so that they may be easily
- installed into an existing Python installation.
+ The manual for developers and packagers of Python modules. This describes
+ how to prepare :mod:`distutils`\ -based packages so that they may be
+ easily installed into an existing Python installation.
:ref:`install-index`
- An "administrators" manual which includes information on installing modules into
- an existing Python installation. You do not need to be a Python programmer to
- read this manual.
+ An "administrators" manual which includes information on installing
+ modules into an existing Python installation. You do not need to be a
+ Python programmer to read this manual.
Modified: python/branches/py3k/Doc/library/errno.rst
==============================================================================
--- python/branches/py3k/Doc/library/errno.rst (original)
+++ python/branches/py3k/Doc/library/errno.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`errno` --- Standard errno system symbols
==============================================
Modified: python/branches/py3k/Doc/library/fcntl.rst
==============================================================================
--- python/branches/py3k/Doc/library/fcntl.rst (original)
+++ python/branches/py3k/Doc/library/fcntl.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`fcntl` --- The :func:`fcntl` and :func:`ioctl` system calls
=================================================================
@@ -65,13 +64,13 @@
so long as the buffer you pass is as least as long as what the operating system
wants to put there, things should work.
- If *mutate_flag* is true (the default), then the buffer is (in effect) passed to the
- underlying :func:`ioctl` system call, the latter's return code is passed back to
- the calling Python, and the buffer's new contents reflect the action of the
- :func:`ioctl`. This is a slight simplification, because if the supplied buffer
- is less than 1024 bytes long it is first copied into a static buffer 1024 bytes
- long which is then passed to :func:`ioctl` and copied back into the supplied
- buffer.
+ If *mutate_flag* is true (the default), then the buffer is (in effect) passed
+ to the underlying :func:`ioctl` system call, the latter's return code is
+ passed back to the calling Python, and the buffer's new contents reflect the
+ action of the :func:`ioctl`. This is a slight simplification, because if the
+ supplied buffer is less than 1024 bytes long it is first copied into a static
+ buffer 1024 bytes long which is then passed to :func:`ioctl` and copied back
+ into the supplied buffer.
An example::
Modified: python/branches/py3k/Doc/library/filecmp.rst
==============================================================================
--- python/branches/py3k/Doc/library/filecmp.rst (original)
+++ python/branches/py3k/Doc/library/filecmp.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`filecmp` --- File and Directory Comparisons
=================================================
@@ -14,7 +13,7 @@
The :mod:`filecmp` module defines the following functions:
-.. function:: cmp(f1, f2[, shallow])
+.. function:: cmp(f1, f2, shallow=True)
Compare the files named *f1* and *f2*, returning ``True`` if they seem equal,
``False`` otherwise.
@@ -29,7 +28,7 @@
portability and efficiency.
-.. function:: cmpfiles(dir1, dir2, common[, shallow])
+.. function:: cmpfiles(dir1, dir2, common, shallow=True)
Compare the files in the two directories *dir1* and *dir2* whose names are
given by *common*.
@@ -66,7 +65,7 @@
:class:`dircmp` instances are built using this constructor:
-.. class:: dircmp(a, b[, ignore[, hide]])
+.. class:: dircmp(a, b, ignore=None, hide=None)
Construct a new directory comparison object, to compare the directories *a* and
*b*. *ignore* is a list of names to ignore, and defaults to ``['RCS', 'CVS',
@@ -159,5 +158,6 @@
.. attribute:: subdirs
- A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` objects.
+ A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp`
+ objects.
Modified: python/branches/py3k/Doc/library/fileformats.rst
==============================================================================
--- python/branches/py3k/Doc/library/fileformats.rst (original)
+++ python/branches/py3k/Doc/library/fileformats.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _fileformats:
************
Modified: python/branches/py3k/Doc/library/fileinput.rst
==============================================================================
--- python/branches/py3k/Doc/library/fileinput.rst (original)
+++ python/branches/py3k/Doc/library/fileinput.rst Sun May 17 14:29:12 2009
@@ -47,7 +47,7 @@
The following function is the primary interface of this module:
-.. function:: input([files[, inplace[, backup[, mode[, openhook]]]]])
+.. function:: input(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None)
Create an instance of the :class:`FileInput` class. The instance will be used
as global state for the functions of this module, and is also returned to use
@@ -115,7 +115,7 @@
available for subclassing as well:
-.. class:: FileInput([files[, inplace[, backup[, mode[, openhook]]]]])
+.. class:: FileInput(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None)
Class :class:`FileInput` is the implementation; its methods :meth:`filename`,
:meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`,
Modified: python/branches/py3k/Doc/library/filesys.rst
==============================================================================
--- python/branches/py3k/Doc/library/filesys.rst (original)
+++ python/branches/py3k/Doc/library/filesys.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
.. _filesys:
*************************
Modified: python/branches/py3k/Doc/library/fnmatch.rst
==============================================================================
--- python/branches/py3k/Doc/library/fnmatch.rst (original)
+++ python/branches/py3k/Doc/library/fnmatch.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`fnmatch` --- Unix filename pattern matching
=================================================
Modified: python/branches/py3k/Doc/library/formatter.rst
==============================================================================
--- python/branches/py3k/Doc/library/formatter.rst (original)
+++ python/branches/py3k/Doc/library/formatter.rst Sun May 17 14:29:12 2009
@@ -165,7 +165,7 @@
:const:`AS_IS` values, is passed to the writer's :meth:`new_styles` method.
-.. method:: formatter.pop_style([n=1])
+.. method:: formatter.pop_style(n=1)
Pop the last *n* style specifications passed to :meth:`push_style`. A tuple
representing the revised stack, including :const:`AS_IS` values, is passed to
@@ -177,7 +177,7 @@
Set the spacing style for the writer.
-.. method:: formatter.assert_line_data([flag=1])
+.. method:: formatter.assert_line_data(flag=1)
Inform the formatter that data has been added to the current paragraph
out-of-band. This should be used when the writer has been manipulated
@@ -194,7 +194,7 @@
applications may use one of these classes without modification or subclassing.
-.. class:: NullFormatter([writer])
+.. class:: NullFormatter(writer=None)
A formatter which does nothing. If *writer* is omitted, a :class:`NullWriter`
instance is created. No methods of the writer are called by
@@ -337,7 +337,7 @@
output.
-.. class:: DumbWriter([file[, maxcol=72]])
+.. class:: DumbWriter(file=None, maxcol=72)
Simple writer class which writes output on the file object passed in as *file*
or, if *file* is omitted, on standard output. The output is simply word-wrapped
Modified: python/branches/py3k/Doc/library/fpectl.rst
==============================================================================
--- python/branches/py3k/Doc/library/fpectl.rst (original)
+++ python/branches/py3k/Doc/library/fpectl.rst Sun May 17 14:29:12 2009
@@ -1,4 +1,3 @@
-
:mod:`fpectl` --- Floating point exception control
==================================================
More information about the Python-checkins
mailing list