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

[zooba]

https://github.com/python/cpython/commit/dc9065f8c2ddc483d387d977e0818d131fa67420
commit: dc9065f8c2ddc483d387d977e0818d131fa67420
branch: 3.11
author: Steve Dower <steve.dower at python.org>
committer: zooba <steve.dower at microsoft.com>
date: 2022-09-23T13:55:06+01:00
summary:

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

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: