From: Georg Brandl <georg@python.org>
Date: Sat, 27 Dec 2008 18:49:19 +0000 (+0000)
Subject: #4754: improve winsound documentation.
X-Git-Tag: v2.7a1~2487
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=348fa7968ba8aa972bf418f1528f9d089f892f34;p=thirdparty%2FPython%2Fcpython.git

#4754: improve winsound documentation.
---

diff --git a/Doc/library/winsound.rst b/Doc/library/winsound.rst
index f9709feab87d..b4a3391d1a99 100644
--- a/Doc/library/winsound.rst
+++ b/Doc/library/winsound.rst
@@ -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