From 2ca21cd316e0c4104928d409e0d99bc046c107db Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 6 Nov 2023 17:31:56 -0800 Subject: [PATCH] Documentation --- docs/source/scopes/cue.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/scopes/cue.rst b/docs/source/scopes/cue.rst index 1e789ea..09d7ab3 100644 --- a/docs/source/scopes/cue.rst +++ b/docs/source/scopes/cue.rst @@ -1,4 +1,16 @@ Cue Marker and Range Metadata ------------------------------ +Notes +===== +Cue metadata stores timed markers that clients use to mark times of interest +in a wave file, and optionally give them a name and longer comment. Markers +can also have an associated length, allowing ranges of times in a file to be +marked. + +Class Reference +=============== + +.. autoclass:: wavinfo.wave_cues_reader.WavCuesReader + :members: