summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Peters <tim.peters@gmail.com>2001-12-06 23:16:09 (GMT)
committerTim Peters <tim.peters@gmail.com>2001-12-06 23:16:09 (GMT)
commitc7cb69263d7b47d68917c72eb558304596bdde18 (patch)
tree7b17f38a8975ebbe6e8c56cbc043b006fd4d0f69
parent9028d0a52529a8bc76868ade697511f29614b207 (diff)
downloadcpython-c7cb69263d7b47d68917c72eb558304596bdde18.zip
cpython-c7cb69263d7b47d68917c72eb558304596bdde18.tar.gz
cpython-c7cb69263d7b47d68917c72eb558304596bdde18.tar.bz2
For ratecv, document that None should be the initial state argument (when
I was squashing spurious overflows in the implementation, I got hung up on this point).
-rw-r--r--Doc/lib/libaudioop.tex3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/lib/libaudioop.tex b/Doc/lib/libaudioop.tex
index 00a91d1..06b1c27 100644
--- a/Doc/lib/libaudioop.tex
+++ b/Doc/lib/libaudioop.tex
@@ -163,7 +163,8 @@ Convert the frame rate of the input fragment.
\var{state} is a tuple containing the state of the converter. The
converter returns a tuple \code{(\var{newfragment}, \var{newstate})},
and \var{newstate} should be passed to the next call of
-\function{ratecv()}.
+\function{ratecv()}. The initial call should pass \code{None}
+as the state.
The \var{weightA} and \var{weightB} arguments are parameters for a
simple digital filter and default to \code{1} and \code{0} respectively.