From cf4c979e8c9687e45a782de94554e2b1744d06e2 Mon Sep 17 00:00:00 2001 From: Kieran Eglin Date: Sat, 20 Jan 2024 18:55:45 -0800 Subject: [PATCH] Improved docs --- lib/pinchflat/rendered_string/parser.ex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/pinchflat/rendered_string/parser.ex b/lib/pinchflat/rendered_string/parser.ex index b3aaed1..ab167fa 100644 --- a/lib/pinchflat/rendered_string/parser.ex +++ b/lib/pinchflat/rendered_string/parser.ex @@ -10,7 +10,8 @@ defmodule Pinchflat.RenderedString.Parser do @doc """ Parses a string into a rendered string, using the provided variables. - The variable keys MUST be strings. + Variable identifiers are surrounded by {{ and }}. The variable keys MUST be strings. + If an identifier is not found in the provided variables, it will be removed from the string. """ def parse(string, variables) do # `do_parse` comes from `RenderedString.Base`