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).

diff --git a/Doc/lib/libaudioop.tex b/Doc/lib/libaudioop.tex
index 00a91d1bf8279490894c5d4ed87ccc765c5d3fd4..06b1c27616f5777ac44fe4044f5f9c74485ca157 100644 (file)
--- 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.