Commit bf863b17 authored by Georg Brandl's avatar Georg Brandl

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

parent 7f758c49
...@@ -16,9 +16,10 @@ AIFF is Audio Interchange File Format, a format for storing digital audio ...@@ -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
......
...@@ -46,11 +46,13 @@ To do just the former: ...@@ -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()
......
...@@ -149,10 +149,12 @@ and the backup file remains around; by default, the extension is ``'.bak'`` and ...@@ -149,10 +149,12 @@ 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)
......
...@@ -42,14 +42,16 @@ and dictionaries are only supported as long as the values contained therein are ...@@ -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.
......
...@@ -17,9 +17,11 @@ The :mod:`shutil` module offers a number of high-level operations on files and ...@@ -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)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment