[Python-checkins] r57074 - in python/trunk/Doc: documenting/markup.rst library/md5.rst library/mimetools.rst library/mimewriter.rst library/mimify.rst library/multifile.rst library/popen2.rst library/posixfile.rst library/rfc822.rst library/sets.rst library/sha.rst library/stringprep.rst library/xmllib.rst library/zipfile.rst

Wed Aug 15 20:41:27 CEST 2007

Author: georg.brandl
Date: Wed Aug 15 20:41:25 2007
New Revision: 57074

Modified:
   python/trunk/Doc/documenting/markup.rst
   python/trunk/Doc/library/md5.rst
   python/trunk/Doc/library/mimetools.rst
   python/trunk/Doc/library/mimewriter.rst
   python/trunk/Doc/library/mimify.rst
   python/trunk/Doc/library/multifile.rst
   python/trunk/Doc/library/popen2.rst
   python/trunk/Doc/library/posixfile.rst
   python/trunk/Doc/library/rfc822.rst
   python/trunk/Doc/library/sets.rst
   python/trunk/Doc/library/sha.rst
   python/trunk/Doc/library/stringprep.rst
   python/trunk/Doc/library/xmllib.rst
   python/trunk/Doc/library/zipfile.rst
Log:
Mark deprecated modules as such.


Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================

--- python/trunk/Doc/documenting/markup.rst	(original)
+++ python/trunk/Doc/documenting/markup.rst	Wed Aug 15 20:41:25 2007
@@ -79,6 +79,9 @@
    The ``synopsis`` option should consist of one sentence describing the
    module's purpose -- it is currently only used in the Global Module Index.
 
+   The ``deprecated`` option can be given (with no value) to mark a module as
+   deprecated; it will be designated as such in various locations then.
+
 .. describe:: moduleauthor
 
    The ``moduleauthor`` directive, which can appear multiple times, names the
@@ -333,6 +336,13 @@
 ``:func:`foo.filter``` clearly refers to the ``filter`` function in the ``foo``
 module.
 
+Normally, names in these roles are searched first without any further
+qualification, then with the current module name prepended, then with the
+current module and class name (if any) prepended.  If you prefix the name with a
+dot, this order is reversed.  For example, in the documentation of the
+:mod:`codecs` module, ``:func:`open``` always refers to the built-in function,
+while ``:func:`.open``` refers to :func:`codecs.open`.
+
 A similar heuristic is used to determine whether the name is an attribute of
 the currently documented class.
 

Modified: python/trunk/Doc/library/md5.rst
==============================================================================
--- python/trunk/Doc/library/md5.rst	(original)
+++ python/trunk/Doc/library/md5.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: md5
    :synopsis: RSA's MD5 message digest algorithm.
+   :deprecated:
 
 
 .. deprecated:: 2.5

Modified: python/trunk/Doc/library/mimetools.rst
==============================================================================
--- python/trunk/Doc/library/mimetools.rst	(original)
+++ python/trunk/Doc/library/mimetools.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: mimetools
    :synopsis: Tools for parsing MIME-style message bodies.
+   :deprecated:
 
 
 .. deprecated:: 2.3

Modified: python/trunk/Doc/library/mimewriter.rst
==============================================================================
--- python/trunk/Doc/library/mimewriter.rst	(original)
+++ python/trunk/Doc/library/mimewriter.rst	Wed Aug 15 20:41:25 2007
@@ -3,6 +3,7 @@
 
 .. module:: MimeWriter
    :synopsis: Write MIME format files.
+   :deprecated:
 
 .. sectionauthor:: Christopher G. Petrilli <petrilli at amber.org>
 

Modified: python/trunk/Doc/library/mimify.rst
==============================================================================
--- python/trunk/Doc/library/mimify.rst	(original)
+++ python/trunk/Doc/library/mimify.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: mimify
    :synopsis: Mimification and unmimification of mail messages.
+   :deprecated:
 
 
 .. deprecated:: 2.3

Modified: python/trunk/Doc/library/multifile.rst
==============================================================================
--- python/trunk/Doc/library/multifile.rst	(original)
+++ python/trunk/Doc/library/multifile.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: multifile
    :synopsis: Support for reading files which contain distinct parts, such as some MIME data.
+   :deprecated:
 .. sectionauthor:: Eric S. Raymond <esr at snark.thyrsus.com>
 
 

Modified: python/trunk/Doc/library/popen2.rst
==============================================================================
--- python/trunk/Doc/library/popen2.rst	(original)
+++ python/trunk/Doc/library/popen2.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: popen2
    :synopsis: Subprocesses with accessible standard I/O streams.
+   :deprecated:
 .. sectionauthor:: Drew Csillag <drew_csillag at geocities.com>
 
 

Modified: python/trunk/Doc/library/posixfile.rst
==============================================================================
--- python/trunk/Doc/library/posixfile.rst	(original)
+++ python/trunk/Doc/library/posixfile.rst	Wed Aug 15 20:41:25 2007
@@ -7,6 +7,7 @@
 .. module:: posixfile
    :platform: Unix
    :synopsis: A file-like object with support for locking.
+   :deprecated:
 .. moduleauthor:: Jaap Vermeulen
 .. sectionauthor:: Jaap Vermeulen
 

Modified: python/trunk/Doc/library/rfc822.rst
==============================================================================
--- python/trunk/Doc/library/rfc822.rst	(original)
+++ python/trunk/Doc/library/rfc822.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: rfc822
    :synopsis: Parse 2822 style mail messages.
+   :deprecated:
 
 
 .. deprecated:: 2.3

Modified: python/trunk/Doc/library/sets.rst
==============================================================================
--- python/trunk/Doc/library/sets.rst	(original)
+++ python/trunk/Doc/library/sets.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: sets
    :synopsis: Implementation of sets of unique elements.
+   :deprecated:
 .. moduleauthor:: Greg V. Wilson <gvwilson at nevex.com>
 .. moduleauthor:: Alex Martelli <aleax at aleax.it>
 .. moduleauthor:: Guido van Rossum <guido at python.org>

Modified: python/trunk/Doc/library/sha.rst
==============================================================================
--- python/trunk/Doc/library/sha.rst	(original)
+++ python/trunk/Doc/library/sha.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: sha
    :synopsis: NIST's secure hash algorithm, SHA.
+   :deprecated:
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
 
 

Modified: python/trunk/Doc/library/stringprep.rst
==============================================================================
--- python/trunk/Doc/library/stringprep.rst	(original)
+++ python/trunk/Doc/library/stringprep.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: stringprep
    :synopsis: String preparation, as per RFC 3453
+   :deprecated:
 .. moduleauthor:: Martin v. Löwis <martin at v.loewis.de>
 .. sectionauthor:: Martin v. Löwis <martin at v.loewis.de>
 

Modified: python/trunk/Doc/library/xmllib.rst
==============================================================================
--- python/trunk/Doc/library/xmllib.rst	(original)
+++ python/trunk/Doc/library/xmllib.rst	Wed Aug 15 20:41:25 2007
@@ -4,6 +4,7 @@
 
 .. module:: xmllib
    :synopsis: A parser for XML documents.
+   :deprecated:
 .. moduleauthor:: Sjoerd Mullender <Sjoerd.Mullender at cwi.nl>
 .. sectionauthor:: Sjoerd Mullender <Sjoerd.Mullender at cwi.nl>
 

Modified: python/trunk/Doc/library/zipfile.rst
==============================================================================
--- python/trunk/Doc/library/zipfile.rst	(original)
+++ python/trunk/Doc/library/zipfile.rst	Wed Aug 15 20:41:25 2007
@@ -168,11 +168,11 @@
    .. note::
 
       If the ZipFile was created by passing in a file-like object as the  first
-      argument to the constructor, then the object returned by :meth:`open` shares the
+      argument to the constructor, then the object returned by :meth:`.open` shares the
       ZipFile's file pointer.  Under these  circumstances, the object returned by
-      :meth:`open` should not  be used after any additional operations are performed
+      :meth:`.open` should not  be used after any additional operations are performed
       on the  ZipFile object.  If the ZipFile was created by passing in a string (the
-      filename) as the first argument to the constructor, then  :meth:`open` will
+      filename) as the first argument to the constructor, then  :meth:`.open` will
       create a new file object that will be held by the ZipExtFile, allowing it to
       operate independently of the  ZipFile.
 
