summaryrefslogtreecommitdiffstats
path: root/Lib/email
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2011-04-12 19:00:44 (GMT)
committerR David Murray <rdmurray@bitdance.com>2011-04-12 19:00:44 (GMT)
commit308f14aeaeab3b8c186c666c5783c657841f8577 (patch)
tree6acd3d86444054265a2f85770a9a02979574e354 /Lib/email
parent84c209a1ef5318c6c3e10ba34658fc3446ab6059 (diff)
downloadcpython-308f14aeaeab3b8c186c666c5783c657841f8577.zip
cpython-308f14aeaeab3b8c186c666c5783c657841f8577.tar.gz
cpython-308f14aeaeab3b8c186c666c5783c657841f8577.tar.bz2
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 a7963ac..e78547c 100644
--- a/Lib/email/header.py
+++ b/Lib/email/header.py
@@ -281,12 +281,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