Commits

Anonymous committed 595c2b5

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

  • Participants
  • Parent commits bfa5835

Comments (0)

Files changed (1)

Doc/whatsnew/3.2.rst

 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
 ----------