[Python-checkins] r57076 - python/trunk/Doc/library/aifc.rst python/trunk/Doc/library/codeop.rst python/trunk/Doc/library/fileinput.rst python/trunk/Doc/library/marshal.rst python/trunk/Doc/library/shutil.rst

Wed Aug 15 21:06:06 CEST 2007

Author: georg.brandl
Date: Wed Aug 15 21:06:04 2007
New Revision: 57076
Modified:
 python/trunk/Doc/library/aifc.rst
 python/trunk/Doc/library/codeop.rst
 python/trunk/Doc/library/fileinput.rst
 python/trunk/Doc/library/marshal.rst
 python/trunk/Doc/library/shutil.rst
Log:
Replace "Caveat" paragraphs by .. warning::s.
Modified: python/trunk/Doc/library/aifc.rst
==============================================================================

--- python/trunk/Doc/library/aifc.rst	(original)
+++ python/trunk/Doc/library/aifc.rst	Wed Aug 15 21:06:04 2007
@@ -16,9 +16,10 @@
 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
Modified: python/trunk/Doc/library/codeop.rst
==============================================================================
--- python/trunk/Doc/library/codeop.rst	(original)
+++ python/trunk/Doc/library/codeop.rst	Wed Aug 15 21:06:04 2007
@@ -46,11 +46,13 @@
 (``'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()
Modified: python/trunk/Doc/library/fileinput.rst
==============================================================================
--- python/trunk/Doc/library/fileinput.rst	(original)
+++ python/trunk/Doc/library/fileinput.rst	Wed Aug 15 21:06:04 2007
@@ -149,10 +149,12 @@
 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)
 
Modified: python/trunk/Doc/library/marshal.rst
==============================================================================
--- python/trunk/Doc/library/marshal.rst	(original)
+++ python/trunk/Doc/library/marshal.rst	Wed Aug 15 21:06:04 2007
@@ -42,14 +42,16 @@
 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.
Modified: python/trunk/Doc/library/shutil.rst
==============================================================================
--- python/trunk/Doc/library/shutil.rst	(original)
+++ python/trunk/Doc/library/shutil.rst	Wed Aug 15 21:06:04 2007
@@ -17,9 +17,11 @@
 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)
