[Python-checkins] cpython (merge 3.5 -> default): Merge #27893: arg name and bytes references in email.parser docs.

r.david.murray python-checkins at python.org
Tue Aug 30 21:17:49 EDT 2016


https://hg.python.org/cpython/rev/059f9f518834
changeset:   102964:059f9f518834
parent:      102962:c9d59e6cc1e4
parent:      102963:b8dd9ae08a91
user:        R David Murray <rdmurray at bitdance.com>
date:        Tue Aug 30 21:17:25 2016 -0400
summary:
  Merge #27893: arg name and bytes references in email.parser docs.

files:
  Doc/library/email.parser.rst |  12 ++++++------
  1 files changed, 6 insertions(+), 6 deletions(-)


diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst
--- a/Doc/library/email.parser.rst
+++ b/Doc/library/email.parser.rst
@@ -202,12 +202,12 @@
       reading the headers or not.  The default is ``False``, meaning it parses
       the entire contents of the file.
 
-   .. method:: parsebytes(bytes, headersonly=False)
+   .. method:: parsebytes(text, headersonly=False)
 
-      Similar to the :meth:`parse` method, except it takes a byte string object
-      instead of a file-like object.  Calling this method on a byte string is
-      exactly equivalent to wrapping *text* in a :class:`~io.BytesIO` instance
-      first and calling :meth:`parse`.
+      Similar to the :meth:`parse` method, except it takes a :term:`bytes-like
+      object` instead of a file-like object.  Calling this method is equivalent
+      to wrapping *text* in a :class:`~io.BytesIO` instance first and calling
+      :meth:`parse`.
 
       Optional *headersonly* is as with the :meth:`parse` method.
 
@@ -233,7 +233,7 @@
 .. function:: message_from_bytes(s, _class=email.message.Message, *, \
                                  policy=policy.compat32)
 
-   Return a message object structure from a byte string.  This is exactly
+   Return a message object structure from a :term:`bytes-like object`.  This is exactly
    equivalent to ``BytesParser().parsebytes(s)``.  Optional *_class* and
    *strict* are interpreted as with the :class:`~email.parser.Parser` class
    constructor.

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list