From 7a148c23571491985b06fde373c29d299cd36447 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 12 May 2008 10:03:16 +0000 Subject: [PATCH] Fix-up docs for socketserver and queue renaming. --- Doc/library/queue.rst | 14 +++++++++----- Doc/library/socketserver.rst | 10 ++++++++-- Doc/library/socketserver_old.rst | 8 -------- Doc/library/threading.rst | 2 +- Doc/reference/simple_stmts.rst | 2 +- Doc/tutorial/stdlib2.rst | 2 +- 6 files changed, 20 insertions(+), 18 deletions(-) delete mode 100644 Doc/library/socketserver_old.rst diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst index ceede527e46..aafd717ce4b 100644 --- a/Doc/library/queue.rst +++ b/Doc/library/queue.rst @@ -1,14 +1,18 @@ - -:mod:`Queue` --- A synchronized queue class +:mod:`queue` --- A synchronized queue class =========================================== .. module:: Queue + :synopsis: Old name for the queue module. + +.. module:: queue :synopsis: A synchronized queue class. .. note:: - The :mod:`Queue` module has been renamed to `queue` in Python 3.0. + The :mod:`Queue` module has been renamed to :mod:`queue` in Python 3.0. It + is importable under both names in Python 2.6 and the rest of the 2.x series. -The :mod:`Queue` module implements multi-producer, multi-consumer queues. + +The :mod:`queue` module implements multi-producer, multi-consumer queues. It is especially useful in threaded programming when information must be exchanged safely between multiple threads. The :class:`Queue` class in this module implements all the required locking semantics. It depends on the @@ -22,7 +26,7 @@ the first retrieved (operating like a stack). With a priority queue, the entries are kept sorted (using the :mod:`heapq` module) and the lowest valued entry is retrieved first. -The :mod:`Queue` module defines the following classes and exceptions: +The :mod:`queue` module defines the following classes and exceptions: .. class:: Queue(maxsize) diff --git a/Doc/library/socketserver.rst b/Doc/library/socketserver.rst index 9df72e3d054..74aeb815e4d 100644 --- a/Doc/library/socketserver.rst +++ b/Doc/library/socketserver.rst @@ -1,10 +1,16 @@ - :mod:`socketserver` --- A framework for network servers ======================================================= +.. module:: SocketServer + :synopsis: Old name for the socketserver module. + .. module:: socketserver :synopsis: A framework for network servers. -.. versionadded:: 2.6 + +.. note:: + The :mod:`SocketServer` module has been renamed to :mod:`socketserver` in + Python 3.0. It is importable under both names in Python 2.6 and the rest of + the 2.x series. The :mod:`socketserver` module simplifies the task of writing network servers. diff --git a/Doc/library/socketserver_old.rst b/Doc/library/socketserver_old.rst deleted file mode 100644 index a6f564e6c94..00000000000 --- a/Doc/library/socketserver_old.rst +++ /dev/null @@ -1,8 +0,0 @@ -:mod:`SocketServer` --- A framework for network servers -======================================================= - -.. module:: SocketServer - :synopsis: A framework for network servers. - -The :mod:`SocketServer` module has been renamed to :mod:`socketserver` -in Python 3.0. The old name is now deprecated. diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 8cb84b3c8c6..7658ebb4b1e 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -8,7 +8,7 @@ This module constructs higher-level threading interfaces on top of the lower level :mod:`thread` module. -See also the :mod:`mutex` and :mod:`Queue` modules. +See also the :mod:`mutex` and :mod:`queue` modules. The :mod:`dummy_threading` module is provided for situations where :mod:`threading` cannot be used because :mod:`thread` is missing. diff --git a/Doc/reference/simple_stmts.rst b/Doc/reference/simple_stmts.rst index e5028ab9a77..1032df9f695 100644 --- a/Doc/reference/simple_stmts.rst +++ b/Doc/reference/simple_stmts.rst @@ -534,7 +534,7 @@ The :keyword:`raise` statement If no expressions are present, :keyword:`raise` re-raises the last exception that was active in the current scope. If no exception is active in the current scope, a :exc:`TypeError` exception is raised indicating that this is an error -(if running under IDLE, a :exc:`Queue.Empty` exception is raised instead). +(if running under IDLE, a :exc:`queue.Empty` exception is raised instead). Otherwise, :keyword:`raise` evaluates the expressions to get three objects, using ``None`` as the value of omitted expressions. The first two objects are diff --git a/Doc/tutorial/stdlib2.rst b/Doc/tutorial/stdlib2.rst index c4db2744de9..9da521355b0 100644 --- a/Doc/tutorial/stdlib2.rst +++ b/Doc/tutorial/stdlib2.rst @@ -198,7 +198,7 @@ variables, and semaphores. While those tools are powerful, minor design errors can result in problems that are difficult to reproduce. So, the preferred approach to task coordination is to concentrate all access to a resource in a single thread and then use the -:mod:`Queue` module to feed that thread with requests from other threads. +:mod:`queue` module to feed that thread with requests from other threads. Applications using :class:`Queue` objects for inter-thread communication and coordination are easier to design, more readable, and more reliable.