From: Barry Warsaw <barry@python.org>
Date: Thu, 6 Mar 2003 06:06:54 +0000 (+0000)
Subject: Describe the new Header.encode() argument "splitchars".
X-Git-Tag: v2.3c1~1565
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f32e3139143f39ec4e4719d70eeee12add9a2598;p=thirdparty%2FPython%2Fcpython.git

Describe the new Header.encode() argument "splitchars".
---

diff --git a/Doc/lib/emailheaders.tex b/Doc/lib/emailheaders.tex
index 8d5964b52af2..d4bbeb858410 100644
--- a/Doc/lib/emailheaders.tex
+++ b/Doc/lib/emailheaders.tex
@@ -109,10 +109,13 @@ 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}{}
+\begin{methoddesc}[Header]{encode}{\optional{splitchars}}
 Encode a message header into an RFC-compliant format, possibly
 wrapping long lines and encapsulating non-\ASCII{} parts in base64 or
-quoted-printable encodings.
+quoted-printable encodings.  Optional \var{splitchars} is a string
+containing characters to split long ASCII lines on, in rough support
+of \rfc{2822}'s \emph{highest level syntactic breaks}.  This doesn't
+affect \rfc{2047} encoded lines.
 \end{methoddesc}
 
 The \class{Header} class also provides a number of methods to support