summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2023-01-15 05:31:59 (GMT)
committerGitHub <noreply@github.com>2023-01-15 05:31:59 (GMT)
commit78c9f39352a04e07ee4de7746c797ca79b5270d7 (patch)
tree61107eade7b39882dbdf9e16cbf5e84f71196cc8
parent1981db9de1f2ce4057de8db1497cd924be82a717 (diff)
downloadcpython-78c9f39352a04e07ee4de7746c797ca79b5270d7.zip
cpython-78c9f39352a04e07ee4de7746c797ca79b5270d7.tar.gz
cpython-78c9f39352a04e07ee4de7746c797ca79b5270d7.tar.bz2
[3.10] gh-101021: Document binary parameters as bytes (GH-101024). (#101052)
(cherry picked from commit 49cae39ef020eaf242607bb2d2d193760b9855a6) Co-authored-by: Bob Kline <bkline@users.noreply.github.com> Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
-rw-r--r--Doc/library/email.mime.rst10
-rw-r--r--Lib/email/mime/application.py2
-rw-r--r--Lib/email/mime/audio.py2
-rw-r--r--Lib/email/mime/image.py2
4 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst
index f37f6aa..98e1258 100644
--- a/Doc/library/email.mime.rst
+++ b/Doc/library/email.mime.rst
@@ -114,9 +114,9 @@ Here are the classes:
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
:class:`MIMEApplication` class is used to represent MIME message objects of
- major type :mimetype:`application`. *_data* is a string containing the raw
- byte data. Optional *_subtype* specifies the MIME subtype and defaults to
- :mimetype:`octet-stream`.
+ major type :mimetype:`application`. *_data* contains the bytes for the raw
+ application data. Optional *_subtype* specifies the MIME subtype and defaults
+ to :mimetype:`octet-stream`.
Optional *_encoder* is a callable (i.e. function) which will perform the actual
encoding of the data for transport. This callable takes one argument, which is
@@ -145,7 +145,7 @@ Here are the classes:
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
:class:`MIMEAudio` class is used to create MIME message objects of major type
- :mimetype:`audio`. *_audiodata* is a string containing the raw audio data. If
+ :mimetype:`audio`. *_audiodata* contains the bytes for the raw audio data. If
this data can be decoded by the standard Python module :mod:`sndhdr`, then the
subtype will be automatically included in the :mailheader:`Content-Type` header.
Otherwise you can explicitly specify the audio subtype via the *_subtype*
@@ -179,7 +179,7 @@ Here are the classes:
A subclass of :class:`~email.mime.nonmultipart.MIMENonMultipart`, the
:class:`MIMEImage` class is used to create MIME message objects of major type
- :mimetype:`image`. *_imagedata* is a string containing the raw image data. If
+ :mimetype:`image`. *_imagedata* contains the bytes for the raw image data. If
this data can be decoded by the standard Python module :mod:`imghdr`, then the
subtype will be automatically included in the :mailheader:`Content-Type` header.
Otherwise you can explicitly specify the image subtype via the *_subtype*
diff --git a/Lib/email/mime/application.py b/Lib/email/mime/application.py
index 6877e55..f67cbad 100644
--- a/Lib/email/mime/application.py
+++ b/Lib/email/mime/application.py
@@ -17,7 +17,7 @@ class MIMEApplication(MIMENonMultipart):
_encoder=encoders.encode_base64, *, policy=None, **_params):
"""Create an application/* type MIME document.
- _data is a string containing the raw application data.
+ _data contains the bytes for the raw application data.
_subtype is the MIME content type subtype, defaulting to
'octet-stream'.
diff --git a/Lib/email/mime/audio.py b/Lib/email/mime/audio.py
index 4bcd7b2..7cca3f9 100644
--- a/Lib/email/mime/audio.py
+++ b/Lib/email/mime/audio.py
@@ -46,7 +46,7 @@ class MIMEAudio(MIMENonMultipart):
_encoder=encoders.encode_base64, *, policy=None, **_params):
"""Create an audio/* type MIME document.
- _audiodata is a string containing the raw audio data. If this data
+ _audiodata contains the bytes for the raw audio data. If this data
can be decoded by the standard Python `sndhdr' module, then the
subtype will be automatically included in the Content-Type header.
Otherwise, you can specify the specific audio subtype via the
diff --git a/Lib/email/mime/image.py b/Lib/email/mime/image.py
index 9272464..6dc7ec4 100644
--- a/Lib/email/mime/image.py
+++ b/Lib/email/mime/image.py
@@ -20,7 +20,7 @@ class MIMEImage(MIMENonMultipart):
_encoder=encoders.encode_base64, *, policy=None, **_params):
"""Create an image/* type MIME document.
- _imagedata is a string containing the raw image data. If this data
+ _imagedata contains the bytes for the raw image data. If the data
can be decoded by the standard Python `imghdr' module, then the
subtype will be automatically included in the Content-Type header.
Otherwise, you can specify the specific image subtype via the _subtype