From: Raymond Hettinger <python@rcn.com>
Date: Sun, 30 Jan 2011 08:20:37 +0000 (+0000)
Subject: Clarify the status of get_string() and recommend using the binary API.
X-Git-Tag: v3.2rc2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ce227e3518ccc8ed26e4befdbb883c24517ba858;p=thirdparty%2FPython%2Fcpython.git

Clarify the status of get_string() and recommend using the binary API.
---

diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index 26d65394ccf2..05d8d21d5a29 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -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
 ----------