Issue #24878: Add docstrings to selected namedtuples

This commit is contained in:
Raymond Hettinger 2015-08-17 22:04:45 -07:00
parent 02aa3426d3
commit 5b798abf5b
6 changed files with 53 additions and 2 deletions

View file

@ -257,6 +257,14 @@ from collections import namedtuple
_aifc_params = namedtuple('_aifc_params',
'nchannels sampwidth framerate nframes comptype compname')
_aifc_params.nchannels.__doc__ = 'Number of audio channels (1 for mono, 2 for stereo)'
_aifc_params.sampwidth.__doc__ = 'Ample width in bytes'
_aifc_params.framerate.__doc__ = 'Sampling frequency'
_aifc_params.nframes.__doc__ = 'Number of audio frames'
_aifc_params.comptype.__doc__ = 'Compression type ("NONE" for AIFF files)'
_aifc_params.compname.__doc__ = ("""A human-readable version ofcompression type
('not compressed' for AIFF files)'""")
class Aifc_read:
# Variables used in this class: