clarify interpolate documentation

dgtized · Mar 11, 2024 · 09c9895 · 09c9895
1 parent ddafd28
commit 09c9895
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/shimmers/math/core.cljc b/src/shimmers/math/core.cljc
@@ -169,7 +169,9 @@
 (defn interpolate
   "For `xs` values, smoothly interpolate using `t` in [0.0,1.0).
 
-  The parameter `k` in [0.0,1.0), determines how long to stay at each values."
+  The values in `xs` are distributed at even intervals along the x-axis in the
+  range of `t`. The parameter `k` in [0.0,1.0), determines how long to stay at
+  each values."
   [xs k t]
   (let [n (count xs)
         k (* 0.5 (mod k 1.0))