[Python-checkins] r77417 - in python/branches/py3k: Doc/library/email.generator.rst Doc/library/email.message.rst Doc/library/email.mime.rst

[r.david.murray]

Author: r.david.murray
Date: Sun Jan 10 20:18:27 2010
New Revision: 77417

Log:
Merged revisions 77412 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77412 | r.david.murray | 2010-01-10 12:41:28 -0500 (Sun, 10 Jan 2010) | 3 lines
  
  Issue #7119: document that a program-generated Message object
  tree may be mutated when serialized.
........


Modified:
   python/branches/py3k/   (props changed)
   python/branches/py3k/Doc/library/email.generator.rst
   python/branches/py3k/Doc/library/email.message.rst
   python/branches/py3k/Doc/library/email.mime.rst

Modified: python/branches/py3k/Doc/library/email.generator.rst
==============================================================================
--- python/branches/py3k/Doc/library/email.generator.rst	(original)
+++ python/branches/py3k/Doc/library/email.generator.rst	Sun Jan 10 20:18:27 2010
@@ -17,7 +17,10 @@
 standards-compliant way, should handle MIME and non-MIME email messages just
 fine, and is designed so that the transformation from flat text, to a message
 structure via the :class:`~email.parser.Parser` class, and back to flat text,
-is idempotent (the input is identical to the output).
+is idempotent (the input is identical to the output).  On the other hand, using
+the Generator on a :class:`~email.message.Message` constructed by program may
+result in changes to the :class:`~email.message.Message` object as defaults are
+filled in.
 
 Here are the public methods of the :class:`Generator` class, imported from the
 :mod:`email.generator` module:

Modified: python/branches/py3k/Doc/library/email.message.rst
==============================================================================
--- python/branches/py3k/Doc/library/email.message.rst	(original)
+++ python/branches/py3k/Doc/library/email.message.rst	Sun Jan 10 20:18:27 2010
@@ -40,7 +40,10 @@
 
       Return the entire message flattened as a string.  When optional *unixfrom*
       is ``True``, the envelope header is included in the returned string.
-      *unixfrom* defaults to ``False``.
+      *unixfrom* defaults to ``False``.  Flattening the message may trigger
+      changes to the :class:`Message` if defaults need to be filled in to
+      complete the transformation to a string (for example, MIME boundaries may
+      be generated or modified).
 
       Note that this method is provided as a convenience and may not always
       format the message the way you want.  For example, by default it mangles

Modified: python/branches/py3k/Doc/library/email.mime.rst
==============================================================================
--- python/branches/py3k/Doc/library/email.mime.rst	(original)
+++ python/branches/py3k/Doc/library/email.mime.rst	Sun Jan 10 20:18:27 2010
@@ -69,7 +69,8 @@
    also be added.
 
    Optional *boundary* is the multipart boundary string.  When ``None`` (the
-   default), the boundary is calculated when needed.
+   default), the boundary is calculated when needed (for example, when the
+   message is serialized).
 
    *_subparts* is a sequence of initial subparts for the payload.  It must be
    possible to convert this sequence to a list.  You can always attach new subparts