Replace "Caveat" paragraphs by .. warning::s.

This commit is contained in:
Georg Brandl 2007-08-15 19:06:04 +00:00
parent 7f758c49fa
commit bf863b17f0
5 changed files with 30 additions and 21 deletions

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
ability to compress the audio data.
**Caveat:** 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.
.. warning::
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
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
will cause :exc:`ValueError` to be raised.
**Caveat:** It is possible (but not likely) that the parser stops parsing with a
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
followed by two newlines may be followed by arbitrary garbage. This will be
fixed once the API for the parser is better.
.. warning::
It is possible (but not likely) that the parser stops parsing with a
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 followed by two newlines may be followed by arbitrary garbage.
This will be fixed once the API for the parser is better.
.. 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
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:
.. function:: hook_compressed(filename, mode)
Transparently opens files compressed with gzip and bzip2 (recognized by the

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
(they will cause infinite loops).
**Caveat:** On machines where C's ``long int`` type has more than 32 bits (such
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
machine where C's ``long int`` type has only 32 bits, a Python long integer
object is returned instead. While of a different type, the numeric value is the
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.)
.. warning::
On machines where C's ``long int`` type has more than 32 bits (such 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 machine
where C's ``long int`` type has only 32 bits, a Python long integer object
is returned instead. While of a different type, the numeric value is the
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
strings.

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
copying and removal.
**Caveat:** 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.
.. warning::
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)