__init__(): The docstring was incorrect regarding how header wrapping

gets done when maxheaderlen <> 0.  The header really gets wrapped via
the email.Header.Header class, which has a more sophisticated
algorithm than just splitting on semi-colons.
This commit is contained in:
Barry Warsaw 2003-11-19 02:23:01 +00:00
parent f8d3bcc77e
commit b03136ad52
1 changed files with 4 additions and 5 deletions

View File

@ -70,11 +70,10 @@ def __init__(self, outfp, mangle_from_=True, maxheaderlen=78):
Optional maxheaderlen specifies the longest length for a non-continued Optional maxheaderlen specifies the longest length for a non-continued
header. When a header line is longer (in characters, with tabs header. When a header line is longer (in characters, with tabs
expanded to 8 spaces), than maxheaderlen, the header will be broken on expanded to 8 spaces) than maxheaderlen, the header will split as
semicolons and continued as per RFC 2822. If no semicolon is found, defined in the Header class. Set maxheaderlen to zero to disable
then the header is left alone. Set to zero to disable wrapping header wrapping. The default is 78, as recommended (but not required)
headers. Default is 78, as recommended (but not required by RFC by RFC 2822.
2822.
""" """
self._fp = outfp self._fp = outfp
self._mangle_from_ = mangle_from_ self._mangle_from_ = mangle_from_