summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2003-11-19 02:22:36 (GMT)
committerBarry Warsaw <barry@python.org>2003-11-19 02:22:36 (GMT)
commitf8d3bcc77eb72d354d14ae7c72d40aace3c42c27 (patch)
tree3f5f09009ea584b07a69c6870df8e67ebb9f7d24
parent3997f58a0c147cee83203ef731e2541c10557335 (diff)
downloadcpython-f8d3bcc77eb72d354d14ae7c72d40aace3c42c27.zip
cpython-f8d3bcc77eb72d354d14ae7c72d40aace3c42c27.tar.gz
cpython-f8d3bcc77eb72d354d14ae7c72d40aace3c42c27.tar.bz2
Generator's constructor: The documentation 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.
-rw-r--r--Doc/lib/emailgenerator.tex5
1 files changed, 2 insertions, 3 deletions
diff --git a/Doc/lib/emailgenerator.tex b/Doc/lib/emailgenerator.tex
index 96eb268..330abc0 100644
--- a/Doc/lib/emailgenerator.tex
+++ b/Doc/lib/emailgenerator.tex
@@ -40,9 +40,8 @@ mailbox format files.
Optional \var{maxheaderlen} specifies the longest length for a
non-continued header. When a header line is longer than
\var{maxheaderlen} (in characters, with tabs expanded to 8 spaces),
-the header will be broken on semicolons and continued as per
-\rfc{2822}. If no semicolon is found, then the header is left alone.
-Set to zero to disable wrapping headers. Default is 78, as
+the header will be split as defined in the \module{email.Header}
+class. Set to zero to disable header wrapping. The default is 78, as
recommended (but not required) by \rfc{2822}.
\end{classdesc}