]> granicus.if.org Git - python/commitdiff
#4754: improve winsound documentation.
authorGeorg Brandl <georg@python.org>
Sat, 27 Dec 2008 18:49:19 +0000 (18:49 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 27 Dec 2008 18:49:19 +0000 (18:49 +0000)
Doc/library/winsound.rst

index f9709feab87d26481b036ede467dd419267be84c..b4a3391d1a991864c8aa37b0177ed5edf4911f12 100644 (file)
@@ -30,8 +30,9 @@ provided by Windows platforms.  It includes functions and several constants.
    Call the underlying :cfunc:`PlaySound` function from the Platform API.  The
    *sound* parameter may be a filename, audio data as a string, or ``None``.  Its
    interpretation depends on the value of *flags*, which can be a bitwise ORed
-   combination of the constants described below.  If the system indicates an error,
-   :exc:`RuntimeError` is raised.
+   combination of the constants described below. If the *sound* parameter is
+   ``None``, any currently playing waveform sound is stopped. If the system
+   indicates an error, :exc:`RuntimeError` is raised.
 
 
 .. function:: MessageBeep([type=MB_OK])
@@ -108,6 +109,10 @@ provided by Windows platforms.  It includes functions and several constants.
 
    Stop playing all instances of the specified sound.
 
+   .. note::
+
+      This flag is not supported on modern Windows platforms.
+
 
 .. data:: SND_ASYNC