traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify what the final argument does in 

IncrementalDecoder.decode().
This commit is contained in:
Walter Dörwald 2006-03-31 09:15:29 +00:00
parent 602d339047
commit a35b05ebd0
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/lib/libcodecs.tex
View 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) 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 and returns the resulting decoded object. If this is the last call to
\method{decode} \var{final} must be true (the default is false). \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} \end{methoddesc}
\begin{methoddesc}{reset}{} \begin{methoddesc}{reset}{}