summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBob Kline <bkline@users.noreply.github.com>2023-01-14 14:01:27 -0500
committerGitHub <noreply@github.com>2023-01-14 11:01:27 -0800
commit49cae39ef020eaf242607bb2d2d193760b9855a6 (patch)
tree60e1123ff5d56e3ab534a48540815265e13a3934
parentef633e5000222a3dba74473c49d6a81fca0a44ec (diff)
downloadcpython-git-49cae39ef020eaf242607bb2d2d193760b9855a6.tar.gz
gh-101021: Document binary parameters as bytes (#101024)
-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 3fe5fe88a0..d7c0d203d1 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 as au, wav, aiff, or aifc, 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 type can be detected (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm,
rast, xbm, bmp, webp, and exr attempted), then the subtype will be
automatically included in the :mailheader:`Content-Type` header. Otherwise
diff --git a/Lib/email/mime/application.py b/Lib/email/mime/application.py
index 6877e554e1..f67cbad3f0 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 8815f5c5ec..065819b2a2 100644
--- a/Lib/email/mime/audio.py
+++ b/Lib/email/mime/audio.py
@@ -18,7 +18,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 as au, wav, aiff, or aifc, 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 e19dea91c0..4b7f2f9cba 100644
--- a/Lib/email/mime/image.py
+++ b/Lib/email/mime/image.py
@@ -17,7 +17,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 the data
+ _imagedata contains the bytes for the raw image data. If the data
type can be detected (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm,
rast, xbm, bmp, webp, and exr attempted), then the subtype will be
automatically included in the Content-Type header. Otherwise, you can