summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-05-12 10:03:16 (GMT)
committerGeorg Brandl <georg@python.org>2008-05-12 10:03:16 (GMT)
commit7a148c23571491985b06fde373c29d299cd36447 (patch)
tree137a6c9c38b3bbd8d0b11c5112c2aad7b47e1f2a /Doc/library
parentbb141bb1f4ece144f681739279dba266f5e64a9d (diff)
downloadcpython-7a148c23571491985b06fde373c29d299cd36447.zip
cpython-7a148c23571491985b06fde373c29d299cd36447.tar.gz
cpython-7a148c23571491985b06fde373c29d299cd36447.tar.bz2
Fix-up docs for socketserver and queue renaming.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/queue.rst14
-rw-r--r--Doc/library/socketserver.rst10
-rw-r--r--Doc/library/socketserver_old.rst8
-rw-r--r--Doc/library/threading.rst2
4 files changed, 18 insertions, 16 deletions
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst
index ceede52..aafd717 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 9df72e3..74aeb81 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 a6f564e..0000000
--- 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 8cb84b3..7658ebb 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.