#27893: arg name and bytes references in email.parser docs.

bitdancer · bitdancer · commit 74eda7608503 · 2016-08-30T21:17:02.000-04:00
Perhaps the BytesParser 'text' argument should really be bytes, but
it hasn't been, it has been text, so for backward compatibility
and for consistency with the regular Parser class, I'm keeping it
as 'text'.
diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst
@@ -202,12 +202,12 @@ have the same API as the :class:`Parser` and :class:`BytesParser` classes.
       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 @@ in the top-level :mod:`email` package namespace.
 .. 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.
