Manually patched a few things that didn't get merged in, but should.

This commit is contained in:
Guido van Rossum 2007-08-17 00:24:54 +00:00
parent af554a0e17
commit da27fd2673
16 changed files with 73 additions and 31 deletions

View File

@ -4,9 +4,9 @@
# #
# You can set these variables from the command line. # You can set these variables from the command line.
PYTHON ?= python PYTHON = python
SVNROOT ?= http://svn.python.org/projects SVNROOT = http://svn.python.org/projects
SPHINXOPTS ?= SPHINXOPTS =
ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER) ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
@ -55,7 +55,7 @@ web: build
htmlhelp: BUILDER = htmlhelp htmlhelp: BUILDER = htmlhelp
htmlhelp: build htmlhelp: build
@echo "Build finished; now you can run HTML Help Workshop with the" \ @echo "Build finished; now you can run HTML Help Workshop with the" \
"build/hhp/pydoc.hhp project file." "build/htmlhelp/pydoc.hhp project file."
clean: clean:
-rm -rf build/* -rm -rf build/*

View File

@ -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 The ``synopsis`` option should consist of one sentence describing the
module's purpose -- it is currently only used in the Global Module Index. 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 .. describe:: moduleauthor
The ``moduleauthor`` directive, which can appear multiple times, names the 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`` ``:func:`foo.filter``` clearly refers to the ``filter`` function in the ``foo``
module. 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 A similar heuristic is used to determine whether the name is an attribute of
the currently documented class. the currently documented class.

View File

@ -16,9 +16,10 @@ AIFF is Audio Interchange File Format, a format for storing digital audio
samples in a file. AIFF-C is a newer version of the format that includes the samples in a file. AIFF-C is a newer version of the format that includes the
ability to compress the audio data. ability to compress the audio data.
**Caveat:** Some operations may only work under IRIX; these will raise .. warning::
:exc:`ImportError` when attempting to import the :mod:`cl` module, which is only
available on IRIX. Some operations may only work under IRIX; these will raise :exc:`ImportError`
when attempting to import the :mod:`cl` module, which is only available on IRIX.
Audio files have a number of parameters that describe the audio data. The Audio files have a number of parameters that describe the audio data. The
sampling rate or frame rate is the number of times per second the sound is sampling rate or frame rate is the number of times per second the sound is

View File

@ -46,11 +46,13 @@ To do just the former:
(``'single'``, the default) or as an expression (``'eval'``). Any other value (``'single'``, the default) or as an expression (``'eval'``). Any other value
will cause :exc:`ValueError` to be raised. will cause :exc:`ValueError` to be raised.
**Caveat:** It is possible (but not likely) that the parser stops parsing with a .. warning::
successful outcome before reaching the end of the source; in this case, trailing
symbols may be ignored instead of causing an error. For example, a backslash It is possible (but not likely) that the parser stops parsing with a
followed by two newlines may be followed by arbitrary garbage. This will be successful outcome before reaching the end of the source; in this case,
fixed once the API for the parser is better. trailing symbols may be ignored instead of causing an error. For example,
a backslash followed by two newlines may be followed by arbitrary garbage.
This will be fixed once the API for the parser is better.
.. class:: Compile() .. class:: Compile()

View File

@ -149,11 +149,13 @@ and the backup file remains around; by default, the extension is ``'.bak'`` and
it is deleted when the output file is closed. In-place filtering is disabled it is deleted when the output file is closed. In-place filtering is disabled
when standard input is read. when standard input is read.
**Caveat:** The current implementation does not work for MS-DOS 8+3 filesystems. .. warning::
The current implementation does not work for MS-DOS 8+3 filesystems.
The two following opening hooks are provided by this module: The two following opening hooks are provided by this module:
.. function:: hook_compressed(filename, mode) .. function:: hook_compressed(filename, mode)
Transparently opens files compressed with gzip and bzip2 (recognized by the Transparently opens files compressed with gzip and bzip2 (recognized by the

View File

@ -536,7 +536,7 @@ instantiated directly, but always through the module-level function
Finds the caller's source filename and line number. Returns the filename, line Finds the caller's source filename and line number. Returns the filename, line
number and function name as a 3-element tuple. number and function name as a 3-element tuple.
.. versionchanged:: 2.5 .. versionchanged:: 2.4
The function name was added. In earlier versions, the filename and line number The function name was added. In earlier versions, the filename and line number
were returned as a 2-element tuple.. were returned as a 2-element tuple..

View File

@ -42,14 +42,16 @@ and dictionaries are only supported as long as the values contained therein are
themselves supported; and recursive lists and dictionaries should not be written themselves supported; and recursive lists and dictionaries should not be written
(they will cause infinite loops). (they will cause infinite loops).
**Caveat:** On machines where C's ``long int`` type has more than 32 bits (such .. warning::
as the DEC Alpha), it is possible to create plain Python integers that are
longer than 32 bits. If such an integer is marshaled and read back in on a On machines where C's ``long int`` type has more than 32 bits (such as the
machine where C's ``long int`` type has only 32 bits, a Python long integer DEC Alpha), it is possible to create plain Python integers that are longer
object is returned instead. While of a different type, the numeric value is the than 32 bits. If such an integer is marshaled and read back in on a machine
same. (This behavior is new in Python 2.2. In earlier versions, all but the where C's ``long int`` type has only 32 bits, a Python long integer object
least-significant 32 bits of the value were lost, and a warning message was is returned instead. While of a different type, the numeric value is the
printed.) same. (This behavior is new in Python 2.2. In earlier versions, all but the
least-significant 32 bits of the value were lost, and a warning message was
printed.)
There are functions that read/write files as well as functions operating on There are functions that read/write files as well as functions operating on
strings. strings.

View File

@ -4,6 +4,7 @@
.. module:: mimetools .. module:: mimetools
:synopsis: Tools for parsing MIME-style message bodies. :synopsis: Tools for parsing MIME-style message bodies.
:deprecated:
.. deprecated:: 2.3 .. deprecated:: 2.3

View File

@ -4,6 +4,7 @@
.. module:: multifile .. module:: multifile
:synopsis: Support for reading files which contain distinct parts, such as some MIME data. :synopsis: Support for reading files which contain distinct parts, such as some MIME data.
:deprecated:
.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>

View File

@ -4,6 +4,7 @@
.. module:: rfc822 .. module:: rfc822
:synopsis: Parse 2822 style mail messages. :synopsis: Parse 2822 style mail messages.
:deprecated:
.. deprecated:: 2.3 .. deprecated:: 2.3

View File

@ -17,9 +17,11 @@ The :mod:`shutil` module offers a number of high-level operations on files and
collections of files. In particular, functions are provided which support file collections of files. In particular, functions are provided which support file
copying and removal. copying and removal.
**Caveat:** On MacOS, the resource fork and other metadata are not used. For .. warning::
file copies, this means that resources will be lost and file type and creator
codes will not be correct. On MacOS, the resource fork and other metadata are not used. For file copies,
this means that resources will be lost and file type and creator codes will
not be correct.
.. function:: copyfile(src, dst) .. function:: copyfile(src, dst)

View File

@ -4,6 +4,7 @@
.. module:: stringprep .. module:: stringprep
:synopsis: String preparation, as per RFC 3453 :synopsis: String preparation, as per RFC 3453
:deprecated:
.. moduleauthor:: Martin v. Löwis <martin@v.loewis.de> .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de>
.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>

View File

@ -107,7 +107,7 @@ the following functions:
based on the definition of canonical equivalence and compatibility equivalence. based on the definition of canonical equivalence and compatibility equivalence.
In Unicode, several characters can be expressed in various way. For example, the In Unicode, several characters can be expressed in various way. For example, the
character U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as character U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as
the sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING CEDILLA). the sequence U+0327 (COMBINING CEDILLA) U+0043 (LATIN CAPITAL LETTER C).
For each character, there are two normal forms: normal form C and normal form D. For each character, there are two normal forms: normal form C and normal form D.
Normal form D (NFD) is also known as canonical decomposition, and translates Normal form D (NFD) is also known as canonical decomposition, and translates
@ -126,6 +126,10 @@ the following functions:
(NFKC) first applies the compatibility decomposition, followed by the canonical (NFKC) first applies the compatibility decomposition, followed by the canonical
composition. composition.
Even if two unicode strings are normalized and look the same to
a human reader, if one has combining characters and the other
doesn't, they may not compare equal.
.. versionadded:: 2.3 .. versionadded:: 2.3
In addition, the module exposes the following constant: In addition, the module exposes the following constant:

View File

@ -168,11 +168,11 @@ ZipFile Objects
.. note:: .. note::
If the ZipFile was created by passing in a file-like object as the first 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 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 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 create a new file object that will be held by the ZipExtFile, allowing it to
operate independently of the ZipFile. operate independently of the ZipFile.

View File

@ -987,7 +987,7 @@ Comparison of objects of the same type depends on the type:
* Strings are compared lexicographically using the numeric equivalents (the * Strings are compared lexicographically using the numeric equivalents (the
result of the built-in function :func:`ord`) of their characters. Unicode and result of the built-in function :func:`ord`) of their characters. Unicode and
8-bit strings are fully interoperable in this behavior. 8-bit strings are fully interoperable in this behavior. [#]_
* Tuples and lists are compared lexicographically using comparison of * Tuples and lists are compared lexicographically using comparison of
corresponding elements. This means that to compare equal, each element must corresponding elements. This means that to compare equal, each element must
@ -1272,6 +1272,12 @@ groups from right to left).
cases, Python returns the latter result, in order to preserve that cases, Python returns the latter result, in order to preserve that
``divmod(x,y)[0] * y + x % y`` be very close to ``x``. ``divmod(x,y)[0] * y + x % y`` be very close to ``x``.
.. [#] While comparisons between unicode strings make sense at the byte
level, they may be counter-intuitive to users. For example, the
strings ``u"\u00C7"`` and ``u"\u0327\u0043"`` compare differently,
even though they both represent the same unicode character (LATIN
CAPTITAL LETTER C WITH CEDILLA).
.. [#] The implementation computes this efficiently, without constructing lists or .. [#] The implementation computes this efficiently, without constructing lists or
sorting. sorting.

View File

@ -10,5 +10,14 @@
import sys import sys
if __name__ == '__main__': if __name__ == '__main__':
if sys.version_info[:3] < (2, 5, 0):
print >>sys.stderr, """\
Error: Sphinx needs to be executed with Python 2.5 or newer.
(If you run this from the Makefile, you can set the PYTHON variable
to the path of an alternative interpreter executable.)
"""
sys.exit(1)
from sphinx import main from sphinx import main
sys.exit(main(sys.argv)) sys.exit(main(sys.argv))