From b2c028a3cb4a63c3e1eefd402bb6304fa6f41e15 Mon Sep 17 00:00:00 2001
From: Jeremy Baxter <jeremy@baxters.nz>
Date: Sun, 2 Jul 2023 08:40:09 +1200
Subject: [PATCH] Add documentation on math.lerp

---
 lmath.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lmath.c b/lmath.c
index b71c0f2..4e86786 100644
--- a/lmath.c
+++ b/lmath.c
@@ -10,6 +10,16 @@
 #include "util.h"
 
 
+/***
+ * Linearly interpolates using the values given.
+ *
+ * Returns `x + (y - x) * z`
+ *
+ * @function lerp
+ * @tparam number x
+ * @tparam number y
+ * @tparam number z
+ */
 static int
 math_lerp(lua_State *L)
 {