From 1ff06bb17880870cb0533653b083d072c4aca97f Mon Sep 17 00:00:00 2001
From: Claudio Ortolina <cloud8421@gmail.com>
Date: Thu, 10 Oct 2024 12:41:35 +0100
Subject: [PATCH] Add disclaimer in search_parser module

---
 lib/music_library/records/search_parser.ex | 8 ++++++++
 1 file changed, 8 insertions(+)

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)