From a35b05ebd05578d5c9491bd54a4f39735a1c937e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Walter=20D=C3=B6rwald?= Date: Fri, 31 Mar 2006 09:15:29 +0000 Subject: Clarify what the final argument does in IncrementalDecoder.decode(). --- Doc/lib/libcodecs.tex | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Doc/lib/libcodecs.tex b/Doc/lib/libcodecs.tex index 951a68a..6baf188 100644 --- a/Doc/lib/libcodecs.tex +++ b/Doc/lib/libcodecs.tex @@ -443,6 +443,10 @@ define in order to be compatible to the Python codec registry. Decodes \var{object} (taking the current state of the decoder into account) and returns the resulting decoded object. If this is the last call to \method{decode} \var{final} must be true (the default is false). + If \var{final} is true the decoder must decode the input completely and must + flush all buffers. If this isn't possible (e.g. because of incomplete byte + sequences at the end of the input) it must initiate error handling just like + in the stateless case (which might raise an exception). \end{methoddesc} \begin{methoddesc}{reset}{} -- cgit v0.12