Verified Commit b31a0e27 authored by Jakob Moser's avatar Jakob Moser
Browse files

Improve documentation

parent 66b1c228

karaokatalog/Library.py

+3 −2
Changes for karaokatalog/Library.py: 3 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -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)