From f516abc2763445b41ff445825ff672297c56303c Mon Sep 17 00:00:00 2001
From: LilyRose2798 <lily@rose.place>
Date: Tue, 19 Mar 2024 19:41:31 +1100
Subject: [PATCH] Add docs to format function

---
 src/sprinkle.gleam | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/sprinkle.gleam b/src/sprinkle.gleam
index 4ca413f..5e14ffe 100644
--- a/src/sprinkle.gleam
+++ b/src/sprinkle.gleam
@@ -1,6 +1,16 @@
 import gleam/string
 import gleam/list
 
+/// Replaces any placeholders in the given format_string
+/// with the values given in the data argument.
+///
+/// ## Examples
+///
+/// ```gleam
+/// format("My name is {name}!", [#("name", "Lily")])
+/// // -> "My name is Lily!"
+/// ```
+///
 pub fn format(format_string: String, data: List(#(String, String))) -> String {
   list.fold(data, format_string, fn(acc, cur) {
     string.replace(acc, each: "{" <> cur.0 <> "}", with: cur.1)