Update documentation to reflect new numericLerp behavior.

[string-lerp.git] / string-lerp.js

diff --git a/string-lerp.js b/string-lerp.js
index 114bebd..8e3ef64 100644 (file)
--- a/string-lerp.js
+++ b/string-lerp.js
@@ -182,10 +182,10 @@
             Numbers may have a leading "-" and a single "." to mark
             the decimal point, but something must be after the ".".
             No other floating point syntax (e.g. 1e6) is supported.
             Numbers may have a leading "-" and a single "." to mark
             the decimal point, but something must be after the ".".
             No other floating point syntax (e.g. 1e6) is supported.

-            If both of the numbers in a pair are integers, the result
-            is clamped to an integer.
+            They are treated as fixed-point values, with the point's
+            position itself interpolating.

 
 

-            For example, numericLerp("0.0", "100", 0.123) === "12.3"
+            For example, numericLerp("0.0", "100".0, 0.123) === "12.3"

             because the "." in "0.0" is interpreted as a decimal
             point. But numericLerp("0.", "100.", 0.123) === "12."
             because the strings are interpreted as integers followed
             because the "." in "0.0" is interpreted as a decimal
             point. But numericLerp("0.", "100.", 0.123) === "12."
             because the strings are interpreted as integers followed