summaryrefslogtreecommitdiffstats
path: root/Lib/email
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-04-12 19:02:07 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-04-12 19:02:07 (GMT)
commitb30f1b41061161225968ab74801694bffea85e1f (patch)
treee8072da86931c2c3f14bd92855be19bc05e5c4c3 /Lib/email
parentb7877f203d66ed693f7dca327963a8ce65c75e03 (diff)
parent94f90dd4a1038232c354c3506a5cf365c4a88531 (diff)
downloadcpython-b30f1b41061161225968ab74801694bffea85e1f.zip
cpython-b30f1b41061161225968ab74801694bffea85e1f.tar.gz
cpython-b30f1b41061161225968ab74801694bffea85e1f.tar.bz2
Merge: Add maxlinelen to docstring, delete obsolete wording
Diffstat (limited to 'Lib/email')
-rw-r--r--Lib/email/header.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/Lib/email/header.py b/Lib/email/header.py
index a0f7c45..1bbf8c5 100644
--- a/Lib/email/header.py
+++ b/Lib/email/header.py
@@ -292,12 +292,12 @@ class Header:
75-character length limit on any given encoded header field, so
line-wrapping must be performed, even with double-byte character sets.
- This method will do its best to convert the string to the correct
- character set used in email, and encode and line wrap it safely with
- the appropriate scheme for that character set.
-
- If the given charset is not known or an error occurs during
- conversion, this function will return the header untouched.
+ Optional maxlinelen specifies the maxiumum length of each generated
+ line, exclusive of the linesep string. Individual lines may be longer
+ than maxlinelen if a folding point cannot be found. The first line
+ will be shorter by the length of the header name plus ": " if a header
+ name was specified at Header construction time. The default value for
+ maxlinelen is determined at header construction time.
Optional splitchars is a string containing characters to split long
ASCII lines on, in rough support of RFC 2822's `highest level