Document that the |mode| parameter to open() is optional and explain how

the default value is determined.
This commit is contained in:
Fred Drake 1999-12-21 18:31:30 +00:00
parent 96b5ee88ee
commit 89ab163479
2 changed files with 14 additions and 10 deletions

View file

@ -12,7 +12,7 @@ mono/stereo.
The \module{wave} module defines the following function and exception:
\begin{funcdesc}{open}{file, mode}
\begin{funcdesc}{open}{file\optional{, mode}}
If \var{file} is a string, open the file by that name, other treat it
as a seekable file-like object. \var{mode} can be any of
\begin{description}
@ -23,7 +23,10 @@ Note that it does not allow read/write WAV files.
A \var{mode} of \code{'r'} or \code{'rb'} returns a \class{Wave_read}
object, while a \var{mode} of \code{'w'} or \code{'wb'} returns
a \class{Wave_write} object.
a \class{Wave_write} object. If \var{mode} is omitted and a file-like
object is passed as \var{file}, \code{\var{file}.mode} is used as the
default value for \var{mode} (the \character{b} flag is still added if
necessary).
\end{funcdesc}
\begin{funcdesc}{openfp}{file, mode}