From 744cce0fb6322c5c2a88c3d318f24662fb08745f Mon Sep 17 00:00:00 2001 From: Aaron Smith <83140718+centau@users.noreply.github.com> Date: Thu, 10 Aug 2023 17:56:14 +0100 Subject: [PATCH] Update docs --- docs/api/animation.md | 9 +++++---- docs/index.md | 2 +- todo.md | 1 + 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/animation.md b/docs/api/animation.md index f73c90e..539f6ba 100644 --- a/docs/api/animation.md +++ b/docs/api/animation.md @@ -2,7 +2,7 @@ ## spring() -Returns a new state with a dynamically animated value of the source. +Returns a new source with a dynamically animated value of the input source. - **Type** @@ -18,9 +18,10 @@ Returns a new state with a dynamically animated value of the source. - **Details** - The output state value is updated every frame based on the source value. + The output source value is updated every frame based on the input source + value. - The change is physically simulated according to a + The output is physically simulated according to a [spring](https://en.wikipedia.org/wiki/Simple_harmonic_motion). `period` is the amount of time in seconds it takes for the spring to @@ -33,4 +34,4 @@ Returns a new state with a dynamically animated value of the source. - <1 = Underdamped - reaches target with some overshoot. - 0 = Undamped - never stabilizes, oscillates forever. - Velocity is conserved between source state updates for smooth animation. + Velocity is conserved between source updates for smooth animation. diff --git a/docs/index.md b/docs/index.md index e707309..6fe3a4a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,6 +19,6 @@ hero: features: - title: In Development - details: Not recommended for production. + details: Not recommended for production use. --- diff --git a/todo.md b/todo.md index a00dd97..3303508 100644 --- a/todo.md +++ b/todo.md @@ -15,3 +15,4 @@ - [ ] batch - [ ] async/resource/loading/suspense - define order with nested properties + - review alternative to nested properties, merge function