jakob/karaokatalog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Activity

Improve documentation

Browse Source
This commit is contained in:
Jakob Moser 2025-05-24 14:42:14 +02:00
parent 66b1c22879
commit b31a0e2760
Signed by: jakob
GPG Key ID: 3EF2BA2851B3F53C
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
karaokatalog/Library.py
View File

@ -16,8 +16,9 @@ class Library:
@classmethod
def from_dir(cls, library_dir: Path) -> Self:
"""
Load a library from a directory by recursively finding all txt files in there
and interpreting them as UltraStar Song TXT files.
Load a library from a directory by recursively finding all *.txt files in there and
treating them as UltraStar DX Song TXT files.
Any *.txt file that cannot be parsed is listed as unparseable Song TXT.
"""
maybe_songs_by_path = {
song_txt: Song.from_song_txt(song_txt)