[Python-checkins] cpython (3.1): Add maxlinelen to docstring, delete obsolete wording

[r.david.murray]

http://hg.python.org/cpython/rev/f9bd0add9732
changeset:   69272:f9bd0add9732
branch:      3.1
parent:      69260:33b54387cc2a
user:        R David Murray <rdmurray at bitdance.com>
date:        Tue Apr 12 15:00:44 2011 -0400
summary:
  Add maxlinelen to docstring, delete obsolete wording

files:
  Lib/email/header.py |  12 ++++++------
  1 files changed, 6 insertions(+), 6 deletions(-)


diff --git a/Lib/email/header.py b/Lib/email/header.py
--- a/Lib/email/header.py
+++ b/Lib/email/header.py
@@ -281,12 +281,12 @@
         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

-- 
Repository URL: http://hg.python.org/cpython