[Python-checkins] gh-77171: Document that wave only supports simple PCM files (GH-97510)

[miss-islington]

https://github.com/python/cpython/commit/2a50772b63d7bc4ef97d16e9bcc53455c301b0ea
commit: 2a50772b63d7bc4ef97d16e9bcc53455c301b0ea
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-09-23T06:04:46-07:00
summary:

gh-77171: Document that wave only supports simple PCM files (GH-97510)

(cherry picked from commit dc9065f8c2ddc483d387d977e0818d131fa67420)

Co-authored-by: Steve Dower <steve.dower at python.org>

files:
M Doc/library/wave.rst

diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst
index f63e0d3dce19..d50aabd5b9c4 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: