]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-77171: Document that wave only supports simple PCM files (GH-97510)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 23 Sep 2022 13:04:46 +0000 (06:04 -0700)
committerGitHub <noreply@github.com>
Fri, 23 Sep 2022 13:04:46 +0000 (06:04 -0700)
(cherry picked from commit dc9065f8c2ddc483d387d977e0818d131fa67420)

Co-authored-by: Steve Dower <steve.dower@python.org>
Doc/library/wave.rst

index f63e0d3dce19c6383828cf2bedbc587f88f2888b..d50aabd5b9c4d91be2c5a2bc35276e642d0fc109 100644 (file)
@@ -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: