Improve documentation
This commit is contained in:
parent
66b1c22879
commit
b31a0e2760
@ -16,8 +16,9 @@ class Library:
|
|||||||
@classmethod
|
@classmethod
|
||||||
def from_dir(cls, library_dir: Path) -> Self:
|
def from_dir(cls, library_dir: Path) -> Self:
|
||||||
"""
|
"""
|
||||||
Load a library from a directory by recursively finding all txt files in there
|
Load a library from a directory by recursively finding all *.txt files in there and
|
||||||
and interpreting them as UltraStar Song TXT files.
|
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 = {
|
maybe_songs_by_path = {
|
||||||
song_txt: Song.from_song_txt(song_txt)
|
song_txt: Song.from_song_txt(song_txt)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user