]> granicus.if.org Git - python/commitdiff
as_string(): Added some text to the docstring to make it clear that
authorBarry Warsaw <barry@python.org>
Fri, 18 Apr 2003 23:04:35 +0000 (23:04 +0000)
committerBarry Warsaw <barry@python.org>
Fri, 18 Apr 2003 23:04:35 +0000 (23:04 +0000)
it's a convenience only and give hints on what to do for more
flexibility.

Lib/email/Message.py

index 66f8640eb1f7459434f59de7051da0deb9a94b0f..0f513f5498560685e184fbda0955317a27ee1a13 100644 (file)
@@ -102,6 +102,10 @@ class Message:
         """Return the entire formatted message as a string.
         Optional `unixfrom' when True, means include the Unix From_ envelope
         header.
+
+        This is a convenience method and may not generate the message exactly
+        as you intend.  For more flexibility, use the flatten() method of a
+        Generator instance.
         """
         from email.Generator import Generator
         fp = StringIO()