summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-09-23 13:04:46 (GMT)
committerGitHub <noreply@github.com>2022-09-23 13:04:46 (GMT)
commit2a50772b63d7bc4ef97d16e9bcc53455c301b0ea (patch)
treebbd18f6818fd4fe020f0ae67883559e9b481d541
parentde9e8aeb4eba7a14a68ba8096bc12b4fd742238c (diff)
downloadcpython-2a50772b63d7bc4ef97d16e9bcc53455c301b0ea.zip
cpython-2a50772b63d7bc4ef97d16e9bcc53455c301b0ea.tar.gz
cpython-2a50772b63d7bc4ef97d16e9bcc53455c301b0ea.tar.bz2
gh-77171: Document that wave only supports simple PCM files (GH-97510)
(cherry picked from commit dc9065f8c2ddc483d387d977e0818d131fa67420) Co-authored-by: Steve Dower <steve.dower@python.org>
-rw-r--r--Doc/library/wave.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst
index f63e0d3..d50aabd 100644
--- a/Doc/library/wave.rst
+++ b/Doc/library/wave.rst
@@ -12,7 +12,8 @@
--------------
The :mod:`wave` module provides a convenient interface to the WAV sound format.
-It does not support compression/decompression, but it does support mono/stereo.
+Only files using ``WAVE_FORMAT_PCM`` are supported. Note that this does not
+include files using ``WAVE_FORMAT_EXTENSIBLE`` even if the subformat is PCM.
The :mod:`wave` module defines the following function and exception: