Remove surplus empty lines and convert more files to new optional arg style.

This commit is contained in:
Georg Brandl 2009-05-17 12:29:12 +00:00
parent ef0a865f9c
commit 71515ca191
39 changed files with 38 additions and 74 deletions

View File

@ -1,4 +1,3 @@
:mod:`abc` --- Abstract Base Classes :mod:`abc` --- Abstract Base Classes
==================================== ====================================

View File

@ -1,4 +1,3 @@
.. _allos: .. _allos:
********************************* *********************************

View File

@ -1,4 +1,3 @@
.. _archiving: .. _archiving:
****************************** ******************************

View File

@ -1,4 +1,3 @@
:mod:`array` --- Efficient arrays of numeric values :mod:`array` --- Efficient arrays of numeric values
=================================================== ===================================================

View File

@ -1,4 +1,3 @@
:mod:`asynchat` --- Asynchronous socket command/response handler :mod:`asynchat` --- Asynchronous socket command/response handler
================================================================ ================================================================

View File

@ -1,4 +1,3 @@
:mod:`asyncore` --- Asynchronous socket handler :mod:`asyncore` --- Asynchronous socket handler
=============================================== ===============================================

View File

@ -1,4 +1,3 @@
:mod:`atexit` --- Exit handlers :mod:`atexit` --- Exit handlers
=============================== ===============================

View File

@ -1,4 +1,3 @@
:mod:`audioop` --- Manipulate raw audio data :mod:`audioop` --- Manipulate raw audio data
============================================ ============================================

View File

@ -1,4 +1,3 @@
:mod:`base64` --- RFC 3548: Base16, Base32, Base64 Data Encodings :mod:`base64` --- RFC 3548: Base16, Base32, Base64 Data Encodings
================================================================= =================================================================

View File

@ -1,4 +1,3 @@
:mod:`binascii` --- Convert between binary and ASCII :mod:`binascii` --- Convert between binary and ASCII
==================================================== ====================================================

View File

@ -1,4 +1,3 @@
:mod:`code` --- Interpreter base classes :mod:`code` --- Interpreter base classes
======================================== ========================================
@ -6,7 +5,6 @@
:synopsis: Facilities to implement read-eval-print loops. :synopsis: Facilities to implement read-eval-print loops.
The ``code`` module provides facilities to implement read-eval-print loops in 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 Python. Two classes and convenience functions are included which can be used to
build applications which provide an interactive interpreter prompt. build applications which provide an interactive interpreter prompt.

View File

@ -1,4 +1,3 @@
:mod:`codeop` --- Compile Python code :mod:`codeop` --- Compile Python code
===================================== =====================================

View File

@ -1,4 +1,3 @@
:mod:`collections` --- Container datatypes :mod:`collections` --- Container datatypes
========================================== ==========================================

View File

@ -1,4 +1,3 @@
:mod:`compileall` --- Byte-compile Python libraries :mod:`compileall` --- Byte-compile Python libraries
=================================================== ===================================================

View File

@ -1,4 +1,3 @@
:mod:`contextlib` --- Utilities for :keyword:`with`\ -statement contexts. :mod:`contextlib` --- Utilities for :keyword:`with`\ -statement contexts.
========================================================================= =========================================================================

View File

@ -1,4 +1,3 @@
:mod:`copy` --- Shallow and deep copy operations :mod:`copy` --- Shallow and deep copy operations
================================================ ================================================

View File

@ -1,6 +1,5 @@
:mod:`copyreg` --- Register :mod:`pickle` support functions :mod:`copyreg` --- Register :mod:`pickle` support functions
============================================================ ===========================================================
.. module:: copyreg .. module:: copyreg
:synopsis: Register pickle support functions. :synopsis: Register pickle support functions.

View File

@ -1,4 +1,3 @@
:mod:`crypt` --- Function to check Unix passwords :mod:`crypt` --- Function to check Unix passwords
================================================= =================================================

View File

@ -1,4 +1,3 @@
.. _crypto: .. _crypto:
********************** **********************

View File

@ -1,4 +1,3 @@
:mod:`csv` --- CSV File Reading and Writing :mod:`csv` --- CSV File Reading and Writing
=========================================== ===========================================

View File

@ -1,6 +1,5 @@
:mod:`ctypes` --- A foreign function library for Python
:mod:`ctypes` --- A foreign function library for Python. =======================================================
========================================================
.. module:: ctypes .. module:: ctypes
:synopsis: A foreign function library for Python. :synopsis: A foreign function library for Python.

View File

@ -1,4 +1,3 @@
:mod:`curses.ascii` --- Utilities for ASCII characters :mod:`curses.ascii` --- Utilities for ASCII characters
====================================================== ======================================================

View File

@ -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 .. module:: curses.panel
:synopsis: A panel stack extension that adds depth to curses windows. :synopsis: A panel stack extension that adds depth to curses windows.

View File

@ -1,9 +1,9 @@
:mod:`curses` --- Terminal handling for character-cell displays :mod:`curses` --- Terminal handling for character-cell displays
=============================================================== ===============================================================
.. module:: curses .. 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@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com> .. sectionauthor:: Eric Raymond <esr@thyrsus.com>

View File

@ -1,4 +1,3 @@
.. _custominterp: .. _custominterp:
************************** **************************

View File

@ -1,4 +1,3 @@
.. _datatypes: .. _datatypes:
********** **********

View File

@ -1,4 +1,3 @@
:mod:`decimal` --- Decimal fixed point and floating point arithmetic :mod:`decimal` --- Decimal fixed point and floating point arithmetic
==================================================================== ====================================================================

View File

@ -1,4 +1,3 @@
.. _development: .. _development:
***************** *****************

View File

@ -1,4 +1,3 @@
:mod:`dis` --- Disassembler for Python bytecode :mod:`dis` --- Disassembler for Python bytecode
=============================================== ===============================================
@ -6,11 +5,11 @@
:synopsis: Disassembler for Python bytecode. :synopsis: Disassembler for Python bytecode.
The :mod:`dis` module supports the analysis of Python :term:`bytecode` by disassembling The :mod:`dis` module supports the analysis of Python :term:`bytecode` by
it. Since there is no Python assembler, this module defines the Python assembly disassembling it. Since there is no Python assembler, this module defines the
language. The Python bytecode which this module takes as an input is defined Python assembly language. The Python bytecode which this module takes as an
in the file :file:`Include/opcode.h` and used by the compiler and the input is defined in the file :file:`Include/opcode.h` and used by the compiler
interpreter. and the interpreter.
Example: Given the function :func:`myfunc`:: Example: Given the function :func:`myfunc`::

View File

@ -1,10 +1,9 @@
:mod:`distutils` --- Building and installing Python modules :mod:`distutils` --- Building and installing Python modules
=========================================================== ===========================================================
.. module:: distutils .. module:: distutils
:synopsis: Support for building and installing Python modules into an existing Python :synopsis: Support for building and installing Python modules into an
installation. existing Python installation.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@ -19,12 +18,12 @@ This package is discussed in two separate chapters:
.. seealso:: .. seealso::
:ref:`distutils-index` :ref:`distutils-index`
The manual for developers and packagers of Python modules. This describes how The manual for developers and packagers of Python modules. This describes
to prepare :mod:`distutils`\ -based packages so that they may be easily how to prepare :mod:`distutils`\ -based packages so that they may be
installed into an existing Python installation. easily installed into an existing Python installation.
:ref:`install-index` :ref:`install-index`
An "administrators" manual which includes information on installing modules into An "administrators" manual which includes information on installing
an existing Python installation. You do not need to be a Python programmer to modules into an existing Python installation. You do not need to be a
read this manual. Python programmer to read this manual.

View File

@ -1,4 +1,3 @@
:mod:`errno` --- Standard errno system symbols :mod:`errno` --- Standard errno system symbols
============================================== ==============================================

View File

@ -1,4 +1,3 @@
:mod:`fcntl` --- The :func:`fcntl` and :func:`ioctl` system calls :mod:`fcntl` --- The :func:`fcntl` and :func:`ioctl` system calls
================================================================= =================================================================
@ -65,13 +64,13 @@ The module defines the following functions:
so long as the buffer you pass is as least as long as what the operating system so long as the buffer you pass is as least as long as what the operating system
wants to put there, things should work. wants to put there, things should work.
If *mutate_flag* is true (the default), then the buffer is (in effect) passed to the If *mutate_flag* is true (the default), then the buffer is (in effect) passed
underlying :func:`ioctl` system call, the latter's return code is passed back to to the underlying :func:`ioctl` system call, the latter's return code is
the calling Python, and the buffer's new contents reflect the action of the passed back to the calling Python, and the buffer's new contents reflect the
:func:`ioctl`. This is a slight simplification, because if the supplied buffer action of the :func:`ioctl`. This is a slight simplification, because if the
is less than 1024 bytes long it is first copied into a static buffer 1024 bytes supplied buffer is less than 1024 bytes long it is first copied into a static
long which is then passed to :func:`ioctl` and copied back into the supplied buffer 1024 bytes long which is then passed to :func:`ioctl` and copied back
buffer. into the supplied buffer.
An example:: An example::

View File

@ -1,4 +1,3 @@
:mod:`filecmp` --- File and Directory Comparisons :mod:`filecmp` --- File and Directory Comparisons
================================================= =================================================
@ -14,7 +13,7 @@ see also the :mod:`difflib` module.
The :mod:`filecmp` module defines the following functions: 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, Compare the files named *f1* and *f2*, returning ``True`` if they seem equal,
``False`` otherwise. ``False`` otherwise.
@ -29,7 +28,7 @@ The :mod:`filecmp` module defines the following functions:
portability and efficiency. 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 Compare the files in the two directories *dir1* and *dir2* whose names are
given by *common*. given by *common*.
@ -66,7 +65,7 @@ The :class:`dircmp` class
:class:`dircmp` instances are built using this constructor: :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 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', *b*. *ignore* is a list of names to ignore, and defaults to ``['RCS', 'CVS',
@ -159,5 +158,6 @@ The :class:`dircmp` class
.. attribute:: subdirs .. 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.

View File

@ -1,4 +1,3 @@
.. _fileformats: .. _fileformats:
************ ************

View File

@ -47,7 +47,7 @@ provided by this module.
The following function is the primary interface of this module: 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 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 as global state for the functions of this module, and is also returned to use
@ -115,7 +115,7 @@ The class which implements the sequence behavior provided by the module is
available for subclassing as well: 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`, Class :class:`FileInput` is the implementation; its methods :meth:`filename`,
:meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`, :meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`,

View File

@ -1,4 +1,3 @@
.. _filesys: .. _filesys:
************************* *************************

View File

@ -1,4 +1,3 @@
:mod:`fnmatch` --- Unix filename pattern matching :mod:`fnmatch` --- Unix filename pattern matching
================================================= =================================================

View File

@ -165,7 +165,7 @@ The following attributes are defined for formatter instance objects:
:const:`AS_IS` values, is passed to the writer's :meth:`new_styles` method. :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 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 representing the revised stack, including :const:`AS_IS` values, is passed to
@ -177,7 +177,7 @@ The following attributes are defined for formatter instance objects:
Set the spacing style for the writer. 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 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 out-of-band. This should be used when the writer has been manipulated
@ -194,7 +194,7 @@ Two implementations of formatter objects are provided by this module. Most
applications may use one of these classes without modification or subclassing. 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` A formatter which does nothing. If *writer* is omitted, a :class:`NullWriter`
instance is created. No methods of the writer are called by instance is created. No methods of the writer are called by
@ -337,7 +337,7 @@ this module. Most applications will need to derive new writer classes from the
output. 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* 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 or, if *file* is omitted, on standard output. The output is simply word-wrapped

View File

@ -1,4 +1,3 @@
:mod:`fpectl` --- Floating point exception control :mod:`fpectl` --- Floating point exception control
================================================== ==================================================