]> granicus.if.org Git - python/commitdiff
Clarify what the final argument does in
authorWalter Dörwald <walter@livinglogic.de>
Fri, 31 Mar 2006 09:15:29 +0000 (09:15 +0000)
committerWalter Dörwald <walter@livinglogic.de>
Fri, 31 Mar 2006 09:15:29 +0000 (09:15 +0000)
IncrementalDecoder.decode().

Doc/lib/libcodecs.tex

index 951a68ae7ba35eb02cc08f9c747b03a335a38031..6baf1888ee85925b7b719a61ef54eaeeb0410192 100644 (file)
@@ -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}{}