diff options
| author | Raymond Hettinger <python@rcn.com> | 2015-08-17 22:04:45 -0700 |
|---|---|---|
| committer | Raymond Hettinger <python@rcn.com> | 2015-08-17 22:04:45 -0700 |
| commit | 987091c333ad1a6be824a843b87816faca8937c4 (patch) | |
| tree | 747c8b9351866e46c5e8764770d315fe8d2cef38 /Lib/aifc.py | |
| parent | 94906103fc231864fdc8b103febcc10bba8ad086 (diff) | |
| download | cpython-987091c333ad1a6be824a843b87816faca8937c4.tar.gz | |
Issue #24878: Add docstrings to selected namedtuples
Diffstat (limited to 'Lib/aifc.py')
| -rw-r--r-- | Lib/aifc.py | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Lib/aifc.py b/Lib/aifc.py index 7ebdbeb68c..1556b53019 100644 --- a/Lib/aifc.py +++ b/Lib/aifc.py @@ -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: |