Improved docs
This commit is contained in:
parent
7dcc893297
commit
cf4c979e8c
1 changed files with 2 additions and 1 deletions
|
|
@ -10,7 +10,8 @@ defmodule Pinchflat.RenderedString.Parser do
|
||||||
@doc """
|
@doc """
|
||||||
Parses a string into a rendered string, using the provided variables.
|
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
|
def parse(string, variables) do
|
||||||
# `do_parse` comes from `RenderedString.Base`
|
# `do_parse` comes from `RenderedString.Base`
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue