summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2003-03-06 06:06:54 (GMT)
committerBarry Warsaw <barry@python.org>2003-03-06 06:06:54 (GMT)
commitf32e3139143f39ec4e4719d70eeee12add9a2598 (patch)
tree388d594d540e4edaf4e3ca91037c2ca5f6aa2f88 /Doc/lib
parent10627ba9b8c03064e288cafc900aa3830fb5a40d (diff)
downloadcpython-f32e3139143f39ec4e4719d70eeee12add9a2598.zip
cpython-f32e3139143f39ec4e4719d70eeee12add9a2598.tar.gz
cpython-f32e3139143f39ec4e4719d70eeee12add9a2598.tar.bz2
Describe the new Header.encode() argument "splitchars".
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/emailheaders.tex7
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/lib/emailheaders.tex b/Doc/lib/emailheaders.tex
index 8d5964b..d4bbeb8 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