Describe the new `errors' argument to Header.__init__() and

warsaw · warsaw · commit d1adc8a6af81 · 2002-12-30T19:17:37.000Z
Header.append()
diff --git a/Doc/lib/emailheaders.tex b/Doc/lib/emailheaders.tex
@@ -48,7 +48,8 @@
 Here is the \class{Header} class description:
 
 \begin{classdesc}{Header}{\optional{s\optional{, charset\optional{,
-    maxlinelen\optional{, header_name\optional{, continuation_ws}}}}}}
+    maxlinelen\optional{, header_name\optional{, continuation_ws\optional{,
+    errors}}}}}}}
 Create a MIME-compliant header that can contain strings in different
 character sets.
 
@@ -79,7 +80,10 @@
 This character will be prepended to continuation lines.
 \end{classdesc}
 
-\begin{methoddesc}[Header]{append}{s\optional{, charset}}
+Optional \var{errors} is passed straight through to the
+\method{append()} method.
+
+\begin{methoddesc}[Header]{append}{s\optional{, charset\optional{, errors}}}
 Append the string \var{s} to the MIME header.
 
 Optional \var{charset}, if given, should be a \class{Charset} instance
@@ -100,6 +104,9 @@
 rules, the Unicode string will be encoded using the following charsets
 in order: \code{us-ascii}, the \var{charset} hint, \code{utf-8}.  The
 first character set to not provoke a \exception{UnicodeError} is used.
+
+Optional \var{errors} is passed through to any \function{unicode()} or
+\function{ustr.encode()} call, and defaults to ``strict''.
 \end{methoddesc}
 
 \begin{methoddesc}[Header]{encode}{}
