[Python-checkins] r56678 - in doctools/trunk: Doc-26/TODO Doc-26/library/cgi.rst Doc-26/library/code.rst Doc-26/library/cookielib.rst Doc-26/library/doctest.rst Doc-26/library/email.mime.rst Doc-26/library/fileinput.rst Doc-26/library/functools.rst Doc-26/library/logging.rst Doc-26/library/mailcap.rst Doc-26/library/mimewriter.rst Doc-26/library/operator.rst Doc-26/library/os.path.rst Doc-26/library/profile.rst Doc-26/library/py_compile.rst Doc-26/library/re.rst Doc-26/library/runpy.rst Doc-26/library/smtpd.rst Doc-26/library/struct.rst Doc-26/library/urllib2.rst Doc-26/library/urlparse.rst Doc-26/library/wsgiref.rst Doc-3k/TODO Doc-3k/library/cgi.rst Doc-3k/library/code.rst Doc-3k/library/cookielib.rst Doc-3k/library/doctest.rst Doc-3k/library/email.mime.rst Doc-3k/library/fileinput.rst Doc-3k/library/functools.rst Doc-3k/library/logging.rst Doc-3k/library/mailcap.rst Doc-3k/library/operator.rst Doc-3k/library/os.path.rst Doc-3k/library/profile.rst Doc-3k/library/py_compile.rst Doc-3k/library/re.rst Doc-3k/library/runpy.rst Doc-3k/library/smtpd.rst Doc-3k/library/struct.rst Doc-3k/library/urllib2.rst Doc-3k/library/urlparse.rst Doc-3k/library/wsgiref.rst
georg.brandl
python-checkins at python.org
Thu Aug 2 22:33:09 CEST 2007
Author: georg.brandl
Date: Thu Aug 2 22:33:06 2007
New Revision: 56678
Modified:
doctools/trunk/Doc-26/TODO
doctools/trunk/Doc-26/library/cgi.rst
doctools/trunk/Doc-26/library/code.rst
doctools/trunk/Doc-26/library/cookielib.rst
doctools/trunk/Doc-26/library/doctest.rst
doctools/trunk/Doc-26/library/email.mime.rst
doctools/trunk/Doc-26/library/fileinput.rst
doctools/trunk/Doc-26/library/functools.rst
doctools/trunk/Doc-26/library/logging.rst
doctools/trunk/Doc-26/library/mailcap.rst
doctools/trunk/Doc-26/library/mimewriter.rst
doctools/trunk/Doc-26/library/operator.rst
doctools/trunk/Doc-26/library/os.path.rst
doctools/trunk/Doc-26/library/profile.rst
doctools/trunk/Doc-26/library/py_compile.rst
doctools/trunk/Doc-26/library/re.rst
doctools/trunk/Doc-26/library/runpy.rst
doctools/trunk/Doc-26/library/smtpd.rst
doctools/trunk/Doc-26/library/struct.rst
doctools/trunk/Doc-26/library/urllib2.rst
doctools/trunk/Doc-26/library/urlparse.rst
doctools/trunk/Doc-26/library/wsgiref.rst
doctools/trunk/Doc-3k/TODO
doctools/trunk/Doc-3k/library/cgi.rst
doctools/trunk/Doc-3k/library/code.rst
doctools/trunk/Doc-3k/library/cookielib.rst
doctools/trunk/Doc-3k/library/doctest.rst
doctools/trunk/Doc-3k/library/email.mime.rst
doctools/trunk/Doc-3k/library/fileinput.rst
doctools/trunk/Doc-3k/library/functools.rst
doctools/trunk/Doc-3k/library/logging.rst
doctools/trunk/Doc-3k/library/mailcap.rst
doctools/trunk/Doc-3k/library/operator.rst
doctools/trunk/Doc-3k/library/os.path.rst
doctools/trunk/Doc-3k/library/profile.rst
doctools/trunk/Doc-3k/library/py_compile.rst
doctools/trunk/Doc-3k/library/re.rst
doctools/trunk/Doc-3k/library/runpy.rst
doctools/trunk/Doc-3k/library/smtpd.rst
doctools/trunk/Doc-3k/library/struct.rst
doctools/trunk/Doc-3k/library/urllib2.rst
doctools/trunk/Doc-3k/library/urlparse.rst
doctools/trunk/Doc-3k/library/wsgiref.rst
Log:
Add missing synopses for library modules.
Modified: doctools/trunk/Doc-26/TODO
==============================================================================
--- doctools/trunk/Doc-26/TODO (original)
+++ doctools/trunk/Doc-26/TODO Thu Aug 2 22:33:06 2007
@@ -4,7 +4,6 @@
* split very large files and add toctrees
* integrate standalone HOWTOs
* find out which files get "comments disabled" metadata
-* add synopses for each module
* write "About these documents"
* finish "Documenting Python"
* extend copyright.rst
Modified: doctools/trunk/Doc-26/library/cgi.rst
==============================================================================
--- doctools/trunk/Doc-26/library/cgi.rst (original)
+++ doctools/trunk/Doc-26/library/cgi.rst Thu Aug 2 22:33:06 2007
@@ -3,8 +3,7 @@
================================================
.. module:: cgi
-
-
+ :synopsis: Helpers for running Python scripts via the Common Gateway Interface.
.. index::
@@ -13,13 +12,10 @@
pair: HTTP; protocol
pair: MIME; headers
single: URL
-
-.. index:: single: Common Gateway Interface
+ single: Common Gateway Interface
Support module for Common Gateway Interface (CGI) scripts.
-.. %
-
This module defines a number of utilities for use by CGI scripts written in
Python.
Modified: doctools/trunk/Doc-26/library/code.rst
==============================================================================
--- doctools/trunk/Doc-26/library/code.rst (original)
+++ doctools/trunk/Doc-26/library/code.rst Thu Aug 2 22:33:06 2007
@@ -3,7 +3,7 @@
========================================
.. module:: code
-
+ :synopsis: Facilities to implement read-eval-print loops.
Modified: doctools/trunk/Doc-26/library/cookielib.rst
==============================================================================
--- doctools/trunk/Doc-26/library/cookielib.rst (original)
+++ doctools/trunk/Doc-26/library/cookielib.rst Thu Aug 2 22:33:06 2007
@@ -3,6 +3,7 @@
=====================================================
.. module:: cookielib
+ :synopsis: Classes for automatic handling of HTTP cookies.
.. moduleauthor:: John J. Lee <jjl at pobox.com>
.. sectionauthor:: John J. Lee <jjl at pobox.com>
Modified: doctools/trunk/Doc-26/library/doctest.rst
==============================================================================
--- doctools/trunk/Doc-26/library/doctest.rst (original)
+++ doctools/trunk/Doc-26/library/doctest.rst Thu Aug 2 22:33:06 2007
@@ -1,16 +1,14 @@
-
:mod:`doctest` --- Test interactive Python examples
===================================================
.. module:: doctest
+ :synopsis: Test pieces of code within docstrings.
.. moduleauthor:: Tim Peters <tim at python.org>
.. sectionauthor:: Tim Peters <tim at python.org>
.. sectionauthor:: Moshe Zadka <moshez at debian.org>
.. sectionauthor:: Edward Loper <edloper at users.sourceforge.net>
-
-
The :mod:`doctest` module searches for pieces of text that look like interactive
Python sessions, and then executes those sessions to verify that they work
exactly as shown. There are several common ways to use doctest:
Modified: doctools/trunk/Doc-26/library/email.mime.rst
==============================================================================
--- doctools/trunk/Doc-26/library/email.mime.rst (original)
+++ doctools/trunk/Doc-26/library/email.mime.rst Thu Aug 2 22:33:06 2007
@@ -1,7 +1,8 @@
:mod:`email`: Creating email and MIME objects from scratch
----------------------------------------------------------
-.. module:: email.mime.text
+.. module:: email.mime
+ :synopsis: Build MIME messages.
Ordinarily, you get a message object structure by passing a file or some text to
Modified: doctools/trunk/Doc-26/library/fileinput.rst
==============================================================================
--- doctools/trunk/Doc-26/library/fileinput.rst (original)
+++ doctools/trunk/Doc-26/library/fileinput.rst Thu Aug 2 22:33:06 2007
@@ -1,14 +1,12 @@
-
:mod:`fileinput` --- Iterate over lines from multiple input streams
===================================================================
.. module:: fileinput
+ :synopsis: Loop over standard input or a list of files.
.. moduleauthor:: Guido van Rossum <guido at python.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
-
-
This module implements a helper class and functions to quickly write a loop over
standard input or a list of files.
Modified: doctools/trunk/Doc-26/library/functools.rst
==============================================================================
--- doctools/trunk/Doc-26/library/functools.rst (original)
+++ doctools/trunk/Doc-26/library/functools.rst Thu Aug 2 22:33:06 2007
@@ -1,18 +1,14 @@
-
-:mod:`functools` --- Higher order functions and operations on callable objects.
-===============================================================================
+:mod:`functools` --- Higher order functions and operations on callable objects
+==============================================================================
.. module:: functools
+ :synopsis: Higher order functions and operations on callable objects.
.. moduleauthor:: Peter Harris <scav at blueyonder.co.uk>
.. moduleauthor:: Raymond Hettinger <python at rcn.com>
.. moduleauthor:: Nick Coghlan <ncoghlan at gmail.com>
.. sectionauthor:: Peter Harris <scav at blueyonder.co.uk>
-.. % standard library, in Python
-
-
-
.. versionadded:: 2.5
The :mod:`functools` module is for higher-order functions: functions that act on
Modified: doctools/trunk/Doc-26/library/logging.rst
==============================================================================
--- doctools/trunk/Doc-26/library/logging.rst (original)
+++ doctools/trunk/Doc-26/library/logging.rst Thu Aug 2 22:33:06 2007
@@ -1,8 +1,8 @@
-
:mod:`logging` --- Logging facility for Python
==============================================
.. module:: logging
+ :synopsis: Flexible error logging system for applications.
.. moduleauthor:: Vinay Sajip <vinay_sajip at red-dove.com>
Modified: doctools/trunk/Doc-26/library/mailcap.rst
==============================================================================
--- doctools/trunk/Doc-26/library/mailcap.rst (original)
+++ doctools/trunk/Doc-26/library/mailcap.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
-:mod:`mailcap` --- Mailcap file handling.
-=========================================
+:mod:`mailcap` --- Mailcap file handling
+========================================
.. module:: mailcap
-
+ :synopsis: Mailcap file handling.
Modified: doctools/trunk/Doc-26/library/mimewriter.rst
==============================================================================
--- doctools/trunk/Doc-26/library/mimewriter.rst (original)
+++ doctools/trunk/Doc-26/library/mimewriter.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`MimeWriter` --- Generic MIME file writer
==============================================
.. module:: MimeWriter
-
+ :synopsis: Write MIME format files.
.. sectionauthor:: Christopher G. Petrilli <petrilli at amber.org>
Modified: doctools/trunk/Doc-26/library/operator.rst
==============================================================================
--- doctools/trunk/Doc-26/library/operator.rst (original)
+++ doctools/trunk/Doc-26/library/operator.rst Thu Aug 2 22:33:06 2007
@@ -1,13 +1,12 @@
-
-:mod:`operator` --- Standard operators as functions.
-====================================================
+:mod:`operator` --- Standard operators as functions
+===================================================
.. module:: operator
+ :synopsis: Functions corresponding to the standard operators.
.. sectionauthor:: Skip Montanaro <skip at automatrix.com>
-
The :mod:`operator` module exports a set of functions implemented in C
corresponding to the intrinsic operators of Python. For example,
``operator.add(x, y)`` is equivalent to the expression ``x+y``. The function
Modified: doctools/trunk/Doc-26/library/os.path.rst
==============================================================================
--- doctools/trunk/Doc-26/library/os.path.rst (original)
+++ doctools/trunk/Doc-26/library/os.path.rst Thu Aug 2 22:33:06 2007
@@ -3,8 +3,7 @@
================================================
.. module:: os.path
-
-
+ :synopsis: Operations on pathnames.
.. index:: single: path; operations
Modified: doctools/trunk/Doc-26/library/profile.rst
==============================================================================
--- doctools/trunk/Doc-26/library/profile.rst (original)
+++ doctools/trunk/Doc-26/library/profile.rst Thu Aug 2 22:33:06 2007
@@ -355,11 +355,9 @@
The :class:`Stats` class is defined in the :mod:`pstats` module.
-.. module:: pstats
-
-.. % now switch modules....
-.. % (This \stmodindex use may be hard to change ;-( )
+.. module:: pstats
+ :synopsis: Statistics object for use with the profiler.
.. class:: Stats(filename[, stream=sys.stdout[, ...]])
Modified: doctools/trunk/Doc-26/library/py_compile.rst
==============================================================================
--- doctools/trunk/Doc-26/library/py_compile.rst (original)
+++ doctools/trunk/Doc-26/library/py_compile.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`py_compile` --- Compile Python source files
=================================================
.. module:: py_compile
-
+ :synopsis: Generate byte-code files from Python source files.
.. % Documentation based on module docstrings, by Fred L. Drake, Jr.
.. % <fdrake at acm.org>
Modified: doctools/trunk/Doc-26/library/re.rst
==============================================================================
--- doctools/trunk/Doc-26/library/re.rst (original)
+++ doctools/trunk/Doc-26/library/re.rst Thu Aug 2 22:33:06 2007
@@ -3,6 +3,7 @@
===========================================
.. module:: re
+ :synopsis: Regular expression operations.
.. moduleauthor:: Fredrik Lundh <fredrik at pythonware.com>
.. sectionauthor:: Andrew M. Kuchling <amk at amk.ca>
Modified: doctools/trunk/Doc-26/library/runpy.rst
==============================================================================
--- doctools/trunk/Doc-26/library/runpy.rst (original)
+++ doctools/trunk/Doc-26/library/runpy.rst Thu Aug 2 22:33:06 2007
@@ -1,15 +1,11 @@
-
-:mod:`runpy` --- Locating and executing Python modules.
-=======================================================
+:mod:`runpy` --- Locating and executing Python modules
+======================================================
.. module:: runpy
+ :synopsis: Locate and run Python modules without importing them first.
.. moduleauthor:: Nick Coghlan <ncoghlan at gmail.com>
-.. % standard library, in Python
-
-
-
.. versionadded:: 2.5
The :mod:`runpy` module is used to locate and run Python modules without
Modified: doctools/trunk/Doc-26/library/smtpd.rst
==============================================================================
--- doctools/trunk/Doc-26/library/smtpd.rst (original)
+++ doctools/trunk/Doc-26/library/smtpd.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`smtpd` --- SMTP Server
============================
.. module:: smtpd
-
+ :synopsis: A SMTP server implementation in Python.
.. moduleauthor:: Barry Warsaw <barry at zope.com>
.. sectionauthor:: Moshe Zadka <moshez at moshez.org>
Modified: doctools/trunk/Doc-26/library/struct.rst
==============================================================================
--- doctools/trunk/Doc-26/library/struct.rst (original)
+++ doctools/trunk/Doc-26/library/struct.rst Thu Aug 2 22:33:06 2007
@@ -3,9 +3,7 @@
=========================================================
.. module:: struct
-
-
-
+ :synopsis: Interpret strings as packed binary data.
.. index::
pair: C; structures
Modified: doctools/trunk/Doc-26/library/urllib2.rst
==============================================================================
--- doctools/trunk/Doc-26/library/urllib2.rst (original)
+++ doctools/trunk/Doc-26/library/urllib2.rst Thu Aug 2 22:33:06 2007
@@ -1,14 +1,12 @@
-
:mod:`urllib2` --- extensible library for opening URLs
======================================================
.. module:: urllib2
+ :synopsis: Next generation URL opening library.
.. moduleauthor:: Jeremy Hylton <jhylton at users.sourceforge.net>
.. sectionauthor:: Moshe Zadka <moshez at users.sourceforge.net>
-
-
The :mod:`urllib2` module defines functions and classes which help in opening
URLs (mostly HTTP) in a complex world --- basic and digest authentication,
redirections, cookies and more.
Modified: doctools/trunk/Doc-26/library/urlparse.rst
==============================================================================
--- doctools/trunk/Doc-26/library/urlparse.rst (original)
+++ doctools/trunk/Doc-26/library/urlparse.rst Thu Aug 2 22:33:06 2007
@@ -1,10 +1,8 @@
-
:mod:`urlparse` --- Parse URLs into components
==============================================
.. module:: urlparse
-
-
+ :synopsis: Parse URLs into or assemble them from components.
.. index::
Modified: doctools/trunk/Doc-26/library/wsgiref.rst
==============================================================================
--- doctools/trunk/Doc-26/library/wsgiref.rst (original)
+++ doctools/trunk/Doc-26/library/wsgiref.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`wsgiref` --- WSGI Utilities and Reference Implementation
==============================================================
.. module:: wsgiref
- :synopsis: WSGI Utilities and Reference Implementation
+ :synopsis: WSGI Utilities and Reference Implementation.
.. moduleauthor:: Phillip J. Eby <pje at telecommunity.com>
.. sectionauthor:: Phillip J. Eby <pje at telecommunity.com>
@@ -37,6 +36,7 @@
-------------------------------------------------
.. module:: wsgiref.util
+ :synopsis: WSGI environment utilities.
This module provides a variety of utility functions for working with WSGI
@@ -142,6 +142,7 @@
----------------------------------------------------
.. module:: wsgiref.headers
+ :synopsis: WSGI response header tools.
This module provides a single class, :class:`Headers`, for convenient
@@ -221,6 +222,7 @@
---------------------------------------------------------
.. module:: wsgiref.simple_server
+ :synopsis: A simple WSGI HTTP server.
This module implements a simple HTTP server (based on :mod:`BaseHTTPServer`)
@@ -232,7 +234,7 @@
:mod:`wsgiref.util`.)
-.. function:: make_server(host, port, app [, server_class=:class:`WSGIServer` [, handler_class=:class:`WSGIRequestHandler`]])
+.. function:: make_server(host, port, app [, server_class=WSGIServer [, handler_class=:class:`WSGIRequestHandler`]])
Create a new WSGI server listening on *host* and *port*, accepting connections
for *app*. The return value is an instance of the supplied *server_class*, and
@@ -327,10 +329,11 @@
interface.
-:mod:`wsgiref.validate` -- WSGI conformance checker
----------------------------------------------------
+:mod:`wsgiref.validate` --- WSGI conformance checker
+----------------------------------------------------
.. module:: wsgiref.validate
+ :synopsis: WSGI conformance checker.
When creating new WSGI application objects, frameworks, servers, or middleware,
@@ -375,6 +378,7 @@
------------------------------------------------------
.. module:: wsgiref.handlers
+ :synopsis: WSGI server/gateway base classes.
This module provides base handler classes for implementing WSGI servers and
Modified: doctools/trunk/Doc-3k/TODO
==============================================================================
--- doctools/trunk/Doc-3k/TODO (original)
+++ doctools/trunk/Doc-3k/TODO Thu Aug 2 22:33:06 2007
@@ -4,7 +4,6 @@
* split very large files and add toctrees
* integrate standalone HOWTOs
* find out which files get "comments disabled" metadata
-* add synopses for each module
* write "About these documents"
* finish "Documenting Python"
* extend copyright.rst
Modified: doctools/trunk/Doc-3k/library/cgi.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/cgi.rst (original)
+++ doctools/trunk/Doc-3k/library/cgi.rst Thu Aug 2 22:33:06 2007
@@ -3,8 +3,7 @@
================================================
.. module:: cgi
-
-
+ :synopsis: Helpers for running Python scripts via the Common Gateway Interface.
.. index::
@@ -13,13 +12,10 @@
pair: HTTP; protocol
pair: MIME; headers
single: URL
-
-.. index:: single: Common Gateway Interface
+ single: Common Gateway Interface
Support module for Common Gateway Interface (CGI) scripts.
-.. %
-
This module defines a number of utilities for use by CGI scripts written in
Python.
Modified: doctools/trunk/Doc-3k/library/code.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/code.rst (original)
+++ doctools/trunk/Doc-3k/library/code.rst Thu Aug 2 22:33:06 2007
@@ -3,7 +3,7 @@
========================================
.. module:: code
-
+ :synopsis: Facilities to implement read-eval-print loops.
Modified: doctools/trunk/Doc-3k/library/cookielib.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/cookielib.rst (original)
+++ doctools/trunk/Doc-3k/library/cookielib.rst Thu Aug 2 22:33:06 2007
@@ -3,6 +3,7 @@
=====================================================
.. module:: cookielib
+ :synopsis: Classes for automatic handling of HTTP cookies.
.. moduleauthor:: John J. Lee <jjl at pobox.com>
.. sectionauthor:: John J. Lee <jjl at pobox.com>
Modified: doctools/trunk/Doc-3k/library/doctest.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/doctest.rst (original)
+++ doctools/trunk/Doc-3k/library/doctest.rst Thu Aug 2 22:33:06 2007
@@ -1,16 +1,14 @@
-
:mod:`doctest` --- Test interactive Python examples
===================================================
.. module:: doctest
+ :synopsis: Test pieces of code within docstrings.
.. moduleauthor:: Tim Peters <tim at python.org>
.. sectionauthor:: Tim Peters <tim at python.org>
.. sectionauthor:: Moshe Zadka <moshez at debian.org>
.. sectionauthor:: Edward Loper <edloper at users.sourceforge.net>
-
-
The :mod:`doctest` module searches for pieces of text that look like interactive
Python sessions, and then executes those sessions to verify that they work
exactly as shown. There are several common ways to use doctest:
Modified: doctools/trunk/Doc-3k/library/email.mime.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/email.mime.rst (original)
+++ doctools/trunk/Doc-3k/library/email.mime.rst Thu Aug 2 22:33:06 2007
@@ -1,7 +1,8 @@
:mod:`email`: Creating email and MIME objects from scratch
----------------------------------------------------------
-.. module:: email.mime.text
+.. module:: email.mime
+ :synopsis: Build MIME messages.
Ordinarily, you get a message object structure by passing a file or some text to
Modified: doctools/trunk/Doc-3k/library/fileinput.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/fileinput.rst (original)
+++ doctools/trunk/Doc-3k/library/fileinput.rst Thu Aug 2 22:33:06 2007
@@ -1,14 +1,12 @@
-
:mod:`fileinput` --- Iterate over lines from multiple input streams
===================================================================
.. module:: fileinput
+ :synopsis: Loop over standard input or a list of files.
.. moduleauthor:: Guido van Rossum <guido at python.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
-
-
This module implements a helper class and functions to quickly write a loop over
standard input or a list of files.
Modified: doctools/trunk/Doc-3k/library/functools.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/functools.rst (original)
+++ doctools/trunk/Doc-3k/library/functools.rst Thu Aug 2 22:33:06 2007
@@ -1,18 +1,14 @@
-
-:mod:`functools` --- Higher order functions and operations on callable objects.
-===============================================================================
+:mod:`functools` --- Higher order functions and operations on callable objects
+==============================================================================
.. module:: functools
+ :synopsis: Higher order functions and operations on callable objects.
.. moduleauthor:: Peter Harris <scav at blueyonder.co.uk>
.. moduleauthor:: Raymond Hettinger <python at rcn.com>
.. moduleauthor:: Nick Coghlan <ncoghlan at gmail.com>
.. sectionauthor:: Peter Harris <scav at blueyonder.co.uk>
-.. % standard library, in Python
-
-
-
.. versionadded:: 2.5
The :mod:`functools` module is for higher-order functions: functions that act on
Modified: doctools/trunk/Doc-3k/library/logging.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/logging.rst (original)
+++ doctools/trunk/Doc-3k/library/logging.rst Thu Aug 2 22:33:06 2007
@@ -1,8 +1,8 @@
-
:mod:`logging` --- Logging facility for Python
==============================================
.. module:: logging
+ :synopsis: Flexible error logging system for applications.
.. moduleauthor:: Vinay Sajip <vinay_sajip at red-dove.com>
Modified: doctools/trunk/Doc-3k/library/mailcap.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/mailcap.rst (original)
+++ doctools/trunk/Doc-3k/library/mailcap.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
-:mod:`mailcap` --- Mailcap file handling.
-=========================================
+:mod:`mailcap` --- Mailcap file handling
+========================================
.. module:: mailcap
-
+ :synopsis: Mailcap file handling.
Modified: doctools/trunk/Doc-3k/library/operator.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/operator.rst (original)
+++ doctools/trunk/Doc-3k/library/operator.rst Thu Aug 2 22:33:06 2007
@@ -1,13 +1,12 @@
-
-:mod:`operator` --- Standard operators as functions.
-====================================================
+:mod:`operator` --- Standard operators as functions
+===================================================
.. module:: operator
+ :synopsis: Functions corresponding to the standard operators.
.. sectionauthor:: Skip Montanaro <skip at automatrix.com>
-
The :mod:`operator` module exports a set of functions implemented in C
corresponding to the intrinsic operators of Python. For example,
``operator.add(x, y)`` is equivalent to the expression ``x+y``. The function
Modified: doctools/trunk/Doc-3k/library/os.path.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/os.path.rst (original)
+++ doctools/trunk/Doc-3k/library/os.path.rst Thu Aug 2 22:33:06 2007
@@ -3,8 +3,7 @@
================================================
.. module:: os.path
-
-
+ :synopsis: Operations on pathnames.
.. index:: single: path; operations
Modified: doctools/trunk/Doc-3k/library/profile.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/profile.rst (original)
+++ doctools/trunk/Doc-3k/library/profile.rst Thu Aug 2 22:33:06 2007
@@ -355,11 +355,9 @@
The :class:`Stats` class is defined in the :mod:`pstats` module.
-.. module:: pstats
-
-.. % now switch modules....
-.. % (This \stmodindex use may be hard to change ;-( )
+.. module:: pstats
+ :synopsis: Statistics object for use with the profiler.
.. class:: Stats(filename[, stream=sys.stdout[, ...]])
Modified: doctools/trunk/Doc-3k/library/py_compile.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/py_compile.rst (original)
+++ doctools/trunk/Doc-3k/library/py_compile.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`py_compile` --- Compile Python source files
=================================================
.. module:: py_compile
-
+ :synopsis: Generate byte-code files from Python source files.
.. % Documentation based on module docstrings, by Fred L. Drake, Jr.
.. % <fdrake at acm.org>
Modified: doctools/trunk/Doc-3k/library/re.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/re.rst (original)
+++ doctools/trunk/Doc-3k/library/re.rst Thu Aug 2 22:33:06 2007
@@ -3,6 +3,7 @@
===========================================
.. module:: re
+ :synopsis: Regular expression operations.
.. moduleauthor:: Fredrik Lundh <fredrik at pythonware.com>
.. sectionauthor:: Andrew M. Kuchling <amk at amk.ca>
Modified: doctools/trunk/Doc-3k/library/runpy.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/runpy.rst (original)
+++ doctools/trunk/Doc-3k/library/runpy.rst Thu Aug 2 22:33:06 2007
@@ -1,15 +1,11 @@
-
-:mod:`runpy` --- Locating and executing Python modules.
-=======================================================
+:mod:`runpy` --- Locating and executing Python modules
+======================================================
.. module:: runpy
+ :synopsis: Locate and run Python modules without importing them first.
.. moduleauthor:: Nick Coghlan <ncoghlan at gmail.com>
-.. % standard library, in Python
-
-
-
.. versionadded:: 2.5
The :mod:`runpy` module is used to locate and run Python modules without
Modified: doctools/trunk/Doc-3k/library/smtpd.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/smtpd.rst (original)
+++ doctools/trunk/Doc-3k/library/smtpd.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`smtpd` --- SMTP Server
============================
.. module:: smtpd
-
+ :synopsis: A SMTP server implementation in Python.
.. moduleauthor:: Barry Warsaw <barry at zope.com>
.. sectionauthor:: Moshe Zadka <moshez at moshez.org>
Modified: doctools/trunk/Doc-3k/library/struct.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/struct.rst (original)
+++ doctools/trunk/Doc-3k/library/struct.rst Thu Aug 2 22:33:06 2007
@@ -3,9 +3,7 @@
=========================================================
.. module:: struct
-
-
-
+ :synopsis: Interpret strings as packed binary data.
.. index::
pair: C; structures
Modified: doctools/trunk/Doc-3k/library/urllib2.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/urllib2.rst (original)
+++ doctools/trunk/Doc-3k/library/urllib2.rst Thu Aug 2 22:33:06 2007
@@ -1,14 +1,12 @@
-
:mod:`urllib2` --- extensible library for opening URLs
======================================================
.. module:: urllib2
+ :synopsis: Next generation URL opening library.
.. moduleauthor:: Jeremy Hylton <jhylton at users.sourceforge.net>
.. sectionauthor:: Moshe Zadka <moshez at users.sourceforge.net>
-
-
The :mod:`urllib2` module defines functions and classes which help in opening
URLs (mostly HTTP) in a complex world --- basic and digest authentication,
redirections, cookies and more.
Modified: doctools/trunk/Doc-3k/library/urlparse.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/urlparse.rst (original)
+++ doctools/trunk/Doc-3k/library/urlparse.rst Thu Aug 2 22:33:06 2007
@@ -1,10 +1,8 @@
-
:mod:`urlparse` --- Parse URLs into components
==============================================
.. module:: urlparse
-
-
+ :synopsis: Parse URLs into or assemble them from components.
.. index::
Modified: doctools/trunk/Doc-3k/library/wsgiref.rst
==============================================================================
--- doctools/trunk/Doc-3k/library/wsgiref.rst (original)
+++ doctools/trunk/Doc-3k/library/wsgiref.rst Thu Aug 2 22:33:06 2007
@@ -1,9 +1,8 @@
-
:mod:`wsgiref` --- WSGI Utilities and Reference Implementation
==============================================================
.. module:: wsgiref
- :synopsis: WSGI Utilities and Reference Implementation
+ :synopsis: WSGI Utilities and Reference Implementation.
.. moduleauthor:: Phillip J. Eby <pje at telecommunity.com>
.. sectionauthor:: Phillip J. Eby <pje at telecommunity.com>
@@ -37,6 +36,7 @@
-------------------------------------------------
.. module:: wsgiref.util
+ :synopsis: WSGI environment utilities.
This module provides a variety of utility functions for working with WSGI
@@ -142,6 +142,7 @@
----------------------------------------------------
.. module:: wsgiref.headers
+ :synopsis: WSGI response header tools.
This module provides a single class, :class:`Headers`, for convenient
@@ -221,6 +222,7 @@
---------------------------------------------------------
.. module:: wsgiref.simple_server
+ :synopsis: A simple WSGI HTTP server.
This module implements a simple HTTP server (based on :mod:`BaseHTTPServer`)
@@ -232,7 +234,7 @@
:mod:`wsgiref.util`.)
-.. function:: make_server(host, port, app [, server_class=:class:`WSGIServer` [, handler_class=:class:`WSGIRequestHandler`]])
+.. function:: make_server(host, port, app [, server_class=WSGIServer [, handler_class=:class:`WSGIRequestHandler`]])
Create a new WSGI server listening on *host* and *port*, accepting connections
for *app*. The return value is an instance of the supplied *server_class*, and
@@ -327,10 +329,11 @@
interface.
-:mod:`wsgiref.validate` -- WSGI conformance checker
----------------------------------------------------
+:mod:`wsgiref.validate` --- WSGI conformance checker
+----------------------------------------------------
.. module:: wsgiref.validate
+ :synopsis: WSGI conformance checker.
When creating new WSGI application objects, frameworks, servers, or middleware,
@@ -375,6 +378,7 @@
------------------------------------------------------
.. module:: wsgiref.handlers
+ :synopsis: WSGI server/gateway base classes.
This module provides base handler classes for implementing WSGI servers and
More information about the Python-checkins
mailing list