diff options
| -rw-r--r-- | Doc/lib/libcodecs.tex | 21 | ||||
| -rw-r--r-- | Doc/lib/libcurses.tex | 10 |
2 files changed, 16 insertions, 15 deletions
diff --git a/Doc/lib/libcodecs.tex b/Doc/lib/libcodecs.tex index ee4ac00..a72df85 100644 --- a/Doc/lib/libcodecs.tex +++ b/Doc/lib/libcodecs.tex @@ -65,40 +65,41 @@ tuple is stored in the cache and returned to the caller. To simplify working with encoded files or stream, the module also defines these utility functions: -\begin{funcdesc}{open}{filename, mode\optional{, encoding=None\optional{, errors='strict'\optional{, buffering=1}}}} +\begin{funcdesc}{open}{filename, mode\optional{, encoding\optional{, + errors\optional{, buffering}}}} Open an encoded file using the given \var{mode} and return a wrapped version providing transparent encoding/decoding. \strong{Note:} The wrapped version will only accept the object format -defined by the codecs, i.e. Unicode objects for most builtin -codecs. Output is also codec dependent and will usually by Unicode as +defined by the codecs, i.e.\ Unicode objects for most built-in +codecs. Output is also codec-dependent and will usually be Unicode as well. \var{encoding} specifies the encoding which is to be used for the the file. \var{errors} may be given to define the error handling. It defaults -to 'strict' which causes a \exception{ValueError} to be raised in case -an encoding error occurs. +to \code{'strict'} which causes a \exception{ValueError} to be raised +in case an encoding error occurs. \var{buffering} has the same meaning as for the built-in \function{open()} function. It defaults to line buffered. \end{funcdesc} -\begin{funcdesc}{EncodedFile}{file, input\optional{, output=None\optional{, errors='strict'}}} - +\begin{funcdesc}{EncodedFile}{file, input\optional{, + output\optional{, errors}}} Return a wrapped version of file which provides transparent encoding translation. Strings written to the wrapped file are interpreted according to the given \var{input} encoding and then written to the original file as -string using the \var{output} encoding. The intermediate encoding will +strings using the \var{output} encoding. The intermediate encoding will usually be Unicode but depends on the specified codecs. -If \var{output} is not given, it defaults to input. +If \var{output} is not given, it defaults to \var{input}. \var{errors} may be given to define the error handling. It defaults to -'strict' which causes \exception{ValueError} to be raised in case +\code{'strict'}, which causes \exception{ValueError} to be raised in case an encoding error occurs. \end{funcdesc} diff --git a/Doc/lib/libcurses.tex b/Doc/lib/libcurses.tex index d0ba2a3..52f9263 100644 --- a/Doc/lib/libcurses.tex +++ b/Doc/lib/libcurses.tex @@ -21,7 +21,7 @@ Unix. characters, regardless of your locale settings.} \seemodule{curses.textbox}{Editable text widget for curses supporting - Emacs-like bindings.} + Emacs-like bindings.} \seetext{Tutorial material on using curses with Python is available on the Python Web site as Andrew Kuchling's \citetitle[http://www.python.org/doc/howto/curses/curses.html]{Curses @@ -349,10 +349,10 @@ Leave echo mode. Echoing of input characters is turned off, Leave newline mode. Disable translation of return into newline on input, and disable low-level translation of newline into newline/return on output (but this does not change the behavior of -addch('\n') which always does the equivalent of return and line feed -on the virtual screen). With translation off, curses can sometimes speed -up vertical motion a little; also, it will be able to detect the -return key on input +\code{addch('\e n')}, which always does the equivalent of return and +line feed on the virtual screen). With translation off, curses can +sometimes speed up vertical motion a little; also, it will be able to +detect the return key on input. \end{funcdesc} \begin{funcdesc}{noqiflush}{} |