summaryrefslogtreecommitdiffstats
path: root/Doc/library/wave.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-04-10 16:31:43 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-04-10 16:31:43 (GMT)
commit671cd3290bb046060c8173b5c8294e35fd02ca3d (patch)
treec38b9878549a936519f590f76001eea5fcc881be /Doc/library/wave.rst
parent3f5ffbee2323770399c9e80cf9c807dc21b3e009 (diff)
downloadcpython-671cd3290bb046060c8173b5c8294e35fd02ca3d.zip
cpython-671cd3290bb046060c8173b5c8294e35fd02ca3d.tar.gz
cpython-671cd3290bb046060c8173b5c8294e35fd02ca3d.tar.bz2
#17487: wave.getparams now returns a namedtuple.
Patch by Claudiu Popa.
Diffstat (limited to 'Doc/library/wave.rst')
-rw-r--r--Doc/library/wave.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst
index afafb45..2e64d00 100644
--- a/Doc/library/wave.rst
+++ b/Doc/library/wave.rst
@@ -98,8 +98,9 @@ Wave_read objects, as returned by :func:`.open`, have the following methods:
.. method:: Wave_read.getparams()
- Returns a tuple ``(nchannels, sampwidth, framerate, nframes, comptype,
- compname)``, equivalent to output of the :meth:`get\*` methods.
+ Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth,
+ framerate, nframes, comptype, compname)``, equivalent to output of the
+ :meth:`get\*` methods.
.. method:: Wave_read.readframes(n)