]> granicus.if.org Git - python/commitdiff
Clarify the status of get_string() and recommend using the binary API.
authorRaymond Hettinger <python@rcn.com>
Sun, 30 Jan 2011 08:20:37 +0000 (08:20 +0000)
committerRaymond Hettinger <python@rcn.com>
Sun, 30 Jan 2011 08:20:37 +0000 (08:20 +0000)
Doc/whatsnew/3.2.rst

index 26d65394ccf27687c377286d21d07638f889e685..05d8d21d5a294d511a00b8cd884d85f523bc55c3 100644 (file)
@@ -2169,8 +2169,13 @@ the file to text-mode).  There is also a new :meth:`~mailbox.Mailbox.get_bytes`
 method that returns a :class:`bytes` representation of a message corresponding
 to a given *key*.
 
-(Contributed by R. David Murray with efforts from Steffen Daode Nurpmeso and
-Victor Stinner in :issue:`9124`.)
+It is still possible to get non-binary output using the old API's
+:meth:`~mailbox.Mailbox.get_string` method, but that approach
+is not very useful.  Instead, it is best to extract messages from
+a :class:`~mailbox.Message` object or to load them from binary input.
+
+(Contributed by R. David Murray, with efforts from Steffen Daode Nurpmeso and an
+initial patch by Victor Stinner in :issue:`9124`.)
 
 turtledemo
 ----------