From c7cb69263d7b47d68917c72eb558304596bdde18 Mon Sep 17 00:00:00 2001
From: Tim Peters <tim.peters@gmail.com>
Date: Thu, 6 Dec 2001 23:16:09 +0000
Subject: 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).

---
 Doc/lib/libaudioop.tex | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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.
-- 
cgit v0.12