Mercurial > cpython-lru_cache-weakref
diff Doc/lib/libcodecs.tex @ 37024:f70c036489ec legacy-trunk
Add some versionadded info to new incremental codec docs and fix doco nits.
| author | Neal Norwitz <nnorwitz@gmail.com> |
|---|---|
| date | Thu, 16 Mar 2006 07:49:19 +0000 |
| parents | 7fa4c29d7030 |
| children | 64c83e0f683e |
line wrap: on
line diff
--- a/Doc/lib/libcodecs.tex Thu Mar 16 07:33:49 2006 +0000 +++ b/Doc/lib/libcodecs.tex Thu Mar 16 07:49:19 2006 +0000 @@ -112,6 +112,7 @@ Raises a \exception{LookupError} in case the encoding cannot be found or the codec doesn't support an incremental encoder. +\versionadded{2.5} \end{funcdesc} \begin{funcdesc}{getincrementaldecoder}{encoding} @@ -120,6 +121,7 @@ Raises a \exception{LookupError} in case the encoding cannot be found or the codec doesn't support an incremental decoder. +\versionadded{2.5} \end{funcdesc} \begin{funcdesc}{getreader}{encoding} @@ -229,12 +231,14 @@ Uses an incremental encoder to iteratively encode the input provided by \var{iterable}. This function is a generator. \var{errors} (as well as any other keyword argument) is passed through to the incremental encoder. +\versionadded{2.5} \end{funcdesc} \begin{funcdesc}{iterdecode}{iterable, encoding\optional{, errors}} Uses an incremental decoder to iteratively decode the input provided by \var{iterable}. This function is a generator. \var{errors} (as well as any other keyword argument) is passed through to the incremental encoder. +\versionadded{2.5} \end{funcdesc} The module also provides the following constants which are useful @@ -355,6 +359,8 @@ \subsubsection{IncrementalEncoder Objects \label{incremental-encoder-objects}} +\versionadded{2.5} + The \class{IncrementalEncoder} class is used for encoding an input in multiple steps. It defines the following methods which every incremental encoder must define in order to be compatible to the Python codec registry.