summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-15 19:06:04 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-15 19:06:04 (GMT)
commitbf863b17f0f67453fe07c4eb57cbede1ee0f6d3f (patch)
treed92dbf71aa544a8d728906de64be9bf5b46e9be0 /Doc/library
parent7f758c49fa9a20df696c0447b14dd4fb75e83662 (diff)
downloadcpython-bf863b17f0f67453fe07c4eb57cbede1ee0f6d3f.zip
cpython-bf863b17f0f67453fe07c4eb57cbede1ee0f6d3f.tar.gz
cpython-bf863b17f0f67453fe07c4eb57cbede1ee0f6d3f.tar.bz2
Replace "Caveat" paragraphs by .. warning::s.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/aifc.rst7
-rw-r--r--Doc/library/codeop.rst12
-rw-r--r--Doc/library/fileinput.rst6
-rw-r--r--Doc/library/marshal.rst18
-rw-r--r--Doc/library/shutil.rst8
5 files changed, 30 insertions, 21 deletions
diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index 0cfcb52..7f7d7fe 100644
--- a/Doc/library/aifc.rst
+++ b/Doc/library/aifc.rst
@@ -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
diff --git a/Doc/library/codeop.rst b/Doc/library/codeop.rst
index 8a730ec..419e873 100644
--- a/Doc/library/codeop.rst
+++ b/Doc/library/codeop.rst
@@ -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()
diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst
index d0a3ed9..d45def1 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -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
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)
diff --git a/Doc/library/marshal.rst b/Doc/library/marshal.rst
index 010ebc3..6927067 100644
--- a/Doc/library/marshal.rst
+++ b/Doc/library/marshal.rst
@@ -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.
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 7ed70af..8cc27d4 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -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)