diff options
-rw-r--r-- | Doc/documenting/markup.rst | 10 | ||||
-rw-r--r-- | Doc/library/md5.rst | 1 | ||||
-rw-r--r-- | Doc/library/mimetools.rst | 1 | ||||
-rw-r--r-- | Doc/library/mimewriter.rst | 1 | ||||
-rw-r--r-- | Doc/library/mimify.rst | 1 | ||||
-rw-r--r-- | Doc/library/multifile.rst | 1 | ||||
-rw-r--r-- | Doc/library/popen2.rst | 1 | ||||
-rw-r--r-- | Doc/library/posixfile.rst | 1 | ||||
-rw-r--r-- | Doc/library/rfc822.rst | 1 | ||||
-rw-r--r-- | Doc/library/sets.rst | 1 | ||||
-rw-r--r-- | Doc/library/sha.rst | 1 | ||||
-rw-r--r-- | Doc/library/stringprep.rst | 1 | ||||
-rw-r--r-- | Doc/library/xmllib.rst | 1 | ||||
-rw-r--r-- | Doc/library/zipfile.rst | 6 |
14 files changed, 25 insertions, 3 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 831fad9..ce042a5 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -79,6 +79,9 @@ As you can see, the module-specific markup consists of two directives, the 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 @@ the current module, or the built-in function of that name. In contrast, ``: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. diff --git a/Doc/library/md5.rst b/Doc/library/md5.rst index 4408372..0495ff5 100644 --- a/Doc/library/md5.rst +++ b/Doc/library/md5.rst @@ -4,6 +4,7 @@ .. module:: md5 :synopsis: RSA's MD5 message digest algorithm. + :deprecated: .. deprecated:: 2.5 diff --git a/Doc/library/mimetools.rst b/Doc/library/mimetools.rst index 603bec6..8da385e 100644 --- a/Doc/library/mimetools.rst +++ b/Doc/library/mimetools.rst @@ -4,6 +4,7 @@ .. module:: mimetools :synopsis: Tools for parsing MIME-style message bodies. + :deprecated: .. deprecated:: 2.3 diff --git a/Doc/library/mimewriter.rst b/Doc/library/mimewriter.rst index cf93473..2070ff6 100644 --- a/Doc/library/mimewriter.rst +++ b/Doc/library/mimewriter.rst @@ -3,6 +3,7 @@ .. module:: MimeWriter :synopsis: Write MIME format files. + :deprecated: .. sectionauthor:: Christopher G. Petrilli <petrilli@amber.org> diff --git a/Doc/library/mimify.rst b/Doc/library/mimify.rst index c5e1359..da0eacc 100644 --- a/Doc/library/mimify.rst +++ b/Doc/library/mimify.rst @@ -4,6 +4,7 @@ .. module:: mimify :synopsis: Mimification and unmimification of mail messages. + :deprecated: .. deprecated:: 2.3 diff --git a/Doc/library/multifile.rst b/Doc/library/multifile.rst index c36ccb7..3e79229 100644 --- a/Doc/library/multifile.rst +++ b/Doc/library/multifile.rst @@ -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@snark.thyrsus.com> diff --git a/Doc/library/popen2.rst b/Doc/library/popen2.rst index d685785..826dff0 100644 --- a/Doc/library/popen2.rst +++ b/Doc/library/popen2.rst @@ -4,6 +4,7 @@ .. module:: popen2 :synopsis: Subprocesses with accessible standard I/O streams. + :deprecated: .. sectionauthor:: Drew Csillag <drew_csillag@geocities.com> diff --git a/Doc/library/posixfile.rst b/Doc/library/posixfile.rst index ec58b94..5ed3483 100644 --- a/Doc/library/posixfile.rst +++ b/Doc/library/posixfile.rst @@ -7,6 +7,7 @@ .. module:: posixfile :platform: Unix :synopsis: A file-like object with support for locking. + :deprecated: .. moduleauthor:: Jaap Vermeulen .. sectionauthor:: Jaap Vermeulen diff --git a/Doc/library/rfc822.rst b/Doc/library/rfc822.rst index fa25ba5..52df013 100644 --- a/Doc/library/rfc822.rst +++ b/Doc/library/rfc822.rst @@ -4,6 +4,7 @@ .. module:: rfc822 :synopsis: Parse 2822 style mail messages. + :deprecated: .. deprecated:: 2.3 diff --git a/Doc/library/sets.rst b/Doc/library/sets.rst index 10cd6a0..f9f8b59 100644 --- a/Doc/library/sets.rst +++ b/Doc/library/sets.rst @@ -4,6 +4,7 @@ .. module:: sets :synopsis: Implementation of sets of unique elements. + :deprecated: .. moduleauthor:: Greg V. Wilson <gvwilson@nevex.com> .. moduleauthor:: Alex Martelli <aleax@aleax.it> .. moduleauthor:: Guido van Rossum <guido@python.org> diff --git a/Doc/library/sha.rst b/Doc/library/sha.rst index 7af043e..3851d94 100644 --- a/Doc/library/sha.rst +++ b/Doc/library/sha.rst @@ -4,6 +4,7 @@ .. module:: sha :synopsis: NIST's secure hash algorithm, SHA. + :deprecated: .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/stringprep.rst b/Doc/library/stringprep.rst index b0944e4..d2f269c 100644 --- a/Doc/library/stringprep.rst +++ b/Doc/library/stringprep.rst @@ -4,6 +4,7 @@ .. module:: stringprep :synopsis: String preparation, as per RFC 3453 + :deprecated: .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> diff --git a/Doc/library/xmllib.rst b/Doc/library/xmllib.rst index 04ca27e..d14754c 100644 --- a/Doc/library/xmllib.rst +++ b/Doc/library/xmllib.rst @@ -4,6 +4,7 @@ .. module:: xmllib :synopsis: A parser for XML documents. + :deprecated: .. moduleauthor:: Sjoerd Mullender <Sjoerd.Mullender@cwi.nl> .. sectionauthor:: Sjoerd Mullender <Sjoerd.Mullender@cwi.nl> diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 5e51bfc..ccc3114 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -168,11 +168,11 @@ ZipFile Objects .. 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. |