From: Fred Drake <fdrake@acm.org>
Date: Fri, 22 Oct 1999 21:08:56 +0000 (+0000)
Subject: Documented Beep() function.
X-Git-Tag: v1.6a1~804
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=714fd26a2fba2049a5c10104b71772d15a933607;p=python

Documented Beep() function.
---

diff --git a/Doc/lib/libwinsound.tex b/Doc/lib/libwinsound.tex
index eacab3be34..153088dd70 100644
--- a/Doc/lib/libwinsound.tex
+++ b/Doc/lib/libwinsound.tex
@@ -10,9 +10,19 @@
 \versionadded{1.5.2}
 
 The \module{winsound} module provides access to the basic
-sound-playing machinery provided by Windows platforms.  It includes a
-single function and several constants.
-
+sound-playing machinery provided by Windows platforms.  It includes
+two functions and several constants.
+
+
+\begin{funcdesc}{Beep}{frequency, duration}
+  Beep the PC's speaker.
+  The \var{frequency} parameter specifies frequency, in hertz, of the
+  sound, and must be in the range 37 through 32,767 (\code{0x25}
+  through \code{0x7fff}).  The \var{duration} parameter specifies the
+  number of milliseconds the sound should last.  If the system is not
+  able to beep the speaker, \exception{RuntimeError} is raised.
+  \versionadded{1.5.3} % XXX fix this version number when release is scheduled!
+\end{funcdesc}
 
 \begin{funcdesc}{PlaySound}{sound, flags}
   Call the underlying \cfunction{PlaySound()} function from the