danvics/pinchflat
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improved docs

Browse source
This commit is contained in:
Kieran Eglin 2024-01-20 18:55:45 -08:00
parent 7dcc893297
commit cf4c979e8c
No known key found for this signature in database
GPG key ID: 193984967FCF432D
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/pinchflat/rendered_string/parser.ex
View file

@ -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`