Added a punch of type annotations

For documentation
This commit is contained in:
Jamie Hardt
2022-11-16 20:40:07 -08:00
parent 90f273cf99
commit fbf4d72915
5 changed files with 57 additions and 46 deletions

View File

@@ -1,11 +1,6 @@
Broadcast WAV Extension
=======================
.. module:: wavinfo
.. autoclass:: wavinfo.wave_bext_reader.WavBextReader
:members:
Notes
-----
@@ -63,3 +58,14 @@ Result:
Originator Time: 12:40:00
Time Reference: 2190940753
A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch
Class Reference
---------------
.. module:: wavinfo
.. autoclass:: wavinfo.wave_bext_reader.WavBextReader
:members:

View File

@@ -1,14 +1,6 @@
INFO Metadata
=============
.. module:: wavinfo
.. autoclass:: wavinfo.wave_info_reader.WavInfoChunkReader
:members:
Notes
-----
@@ -28,5 +20,14 @@ music library software.
print("INFO Comment:", bullet.info.comment)
Class Reference
---------------
.. module:: wavinfo
.. autoclass:: wavinfo.wave_info_reader.WavInfoChunkReader
:members:

View File

@@ -1,13 +1,6 @@
iXML Production Recorder Metadata
=================================
.. module:: wavinfo
.. autoclass:: wavinfo.wave_ixml_reader.WavIXMLFormat
:members:
Notes
-----
iXML allows an XML document to be embedded in a WAV file.
@@ -41,4 +34,12 @@ Result:
iXML File Family UID: USSDVGR1112089007124001008206300
Class Reference
---------------
.. module:: wavinfo
.. autoclass:: wavinfo.wave_ixml_reader.WavIXMLFormat
:members: