diff --git a/lyric_search_new/constructors.py b/lyric_search_new/constructors.py index fdc82d3..86f4776 100644 --- a/lyric_search_new/constructors.py +++ b/lyric_search_new/constructors.py @@ -4,11 +4,17 @@ from dataclasses import dataclass, asdict @dataclass class LyricsResult: - """Class for returned Lyrics Results""" + """Class for returned Lyrics Results + @artist: returned artist + @song: returned song + @src: source result was fetched from + @lyrics: str if plain lyrics, list for lrc + @time: time taken to retrieve lyrics from source + """ artist: str song: str src: str - lyrics: str|dict + lyrics: str|list confidence: int time: float = 0.00