docstring stuff

This commit is contained in:
2025-01-19 07:01:07 -05:00
parent 151643c5dc
commit be0ef08f3d
9 changed files with 118 additions and 52 deletions

View File

@@ -4,12 +4,14 @@ from dataclasses import dataclass, asdict
@dataclass
class LyricsResult:
"""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
"""
Class for returned Lyrics Results
Attributes:
artist (str): returned artist
song (str): returned song
src (str): source result was fetched from
lyrics (str|list): str if plain lyrics, list for lrc
time (float): time taken to retrieve lyrics from source
"""
artist: str
song: str