Add disclaimer in search_parser module

2024-10-10 12:41:35 +01:00
parent 02a071be28
commit 1ff06bb178
1 changed files with 8 additions and 0 deletions
@@ -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)