]> granicus.if.org Git - python/commitdiff
Replace "Caveat" paragraphs by .. warning::s.
authorGeorg Brandl <georg@python.org>
Wed, 15 Aug 2007 19:06:04 +0000 (19:06 +0000)
committerGeorg Brandl <georg@python.org>
Wed, 15 Aug 2007 19:06:04 +0000 (19:06 +0000)
Doc/library/aifc.rst
Doc/library/codeop.rst
Doc/library/fileinput.rst
Doc/library/marshal.rst
Doc/library/shutil.rst

index 0cfcb52cecff7e5674dfd0b5dbf0d538a94dedda..7f7d7feeaf942488a48504078d24f7d3a26c7913 100644 (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
index 8a730ec02712280d33bf231d275efc592342e031..419e8735d196740c8b91600a7a17bc45e8325f99 100644 (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()
index d0a3ed903f0e7ef4d15458c825044d7bcd88b615..d45def1d20619a7f8c741f9a91762e83d84729d5 100644 (file)
@@ -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)
 
index 010ebc3c77e5138a7545b6437c56491e6957194f..6927067ab6bccaa3e33ce3f028fbed42c877dc05 100644 (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.
index 7ed70af68a3fbc0c3f0f603d0ca4b0bf4262743b..8cc27d4faba8056f0259699248ad7dd6be4c3851 100644 (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)