From f32e3139143f39ec4e4719d70eeee12add9a2598 Mon Sep 17 00:00:00 2001
From: Barry Warsaw <barry@python.org>
Date: Thu, 6 Mar 2003 06:06:54 +0000
Subject: Describe the new Header.encode() argument "splitchars".

---
 Doc/lib/emailheaders.tex | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'Doc/lib/emailheaders.tex')

diff --git a/Doc/lib/emailheaders.tex b/Doc/lib/emailheaders.tex
index 8d5964b52a..d4bbeb8584 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
-- 
cgit v1.2.1

