diff --git a/lib/music_library/records/search_parser.ex b/lib/music_library/records/search_parser.ex index d1e05cdc..0a462f0f 100644 --- a/lib/music_library/records/search_parser.ex +++ b/lib/music_library/records/search_parser.ex @@ -1,4 +1,12 @@ defmodule MusicLibrary.Records.SearchParser do + @moduledoc """ + This module includes functions to parse a search string containing tagged entities, + e.g. artists or albums. + + Implementation is most likely suboptimal, non-idiomatic and failing against specific + edge cases I haven't thought about - not an expert in parsing. + """ + import NimbleParsec word = utf8_string([not: ?\s], min: 1)