Skip to content

Commit 689ae2d

Browse files
committed
wave docs: add format constants as data
1 parent de0c82e commit 689ae2d

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

Doc/library/wave.rst

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,21 @@ The :mod:`!wave` module defines the following function and exception:
6565
specification or hits an implementation deficiency.
6666

6767

68+
.. data:: WAVE_FORMAT_PCM
69+
70+
Format code for uncompressed PCM audio.
71+
72+
73+
.. data:: WAVE_FORMAT_IEEE_FLOAT
74+
75+
Format code for IEEE floating-point audio.
76+
77+
78+
.. data:: WAVE_FORMAT_EXTENSIBLE
79+
80+
Format code for WAVE extensible headers.
81+
82+
6883
.. _wave-read-objects:
6984

7085
Wave_read Objects
@@ -107,8 +122,8 @@ Wave_read Objects
107122

108123
Returns the frame format code.
109124

110-
This is one of ``WAVE_FORMAT_PCM``, ``WAVE_FORMAT_IEEE_FLOAT``, or
111-
``WAVE_FORMAT_EXTENSIBLE``.
125+
This is one of :data:`WAVE_FORMAT_PCM`,
126+
:data:`WAVE_FORMAT_IEEE_FLOAT`, or :data:`WAVE_FORMAT_EXTENSIBLE`.
112127

113128

114129
.. method:: getcomptype()
@@ -255,8 +270,8 @@ Wave_write Objects
255270

256271
Set the frame format code.
257272

258-
Supported values are ``WAVE_FORMAT_PCM`` and
259-
``WAVE_FORMAT_IEEE_FLOAT``.
273+
Supported values are :data:`WAVE_FORMAT_PCM` and
274+
:data:`WAVE_FORMAT_IEEE_FLOAT`.
260275

261276

262277
.. method:: getformat()
@@ -271,7 +286,7 @@ Wave_write Objects
271286
with values valid for the ``set*()`` methods. Sets all parameters.
272287

273288
For backwards compatibility, a 6-item tuple without *format* is also
274-
accepted and defaults to ``WAVE_FORMAT_PCM``.
289+
accepted and defaults to :data:`WAVE_FORMAT_PCM`.
275290

276291

277292
.. method:: getparams()
@@ -309,5 +324,5 @@ Wave_write Objects
309324
or :meth:`writeframesraw`, and any attempt to do so will raise
310325
:exc:`wave.Error`.
311326

312-
For ``WAVE_FORMAT_IEEE_FLOAT`` output, a ``fact`` chunk is written as
327+
For :data:`WAVE_FORMAT_IEEE_FLOAT` output, a ``fact`` chunk is written as
313328
required by the WAVE specification for non-PCM formats.

0 commit comments

Comments
 (0)