From d7cdda7b38bb00d7cb74ed5b7be3cb95f496946f Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Tue, 25 Apr 2017 18:18:23 +0800 Subject: [PATCH] updated doc --- docs/lib-golden_spiral.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/lib-golden_spiral.md b/docs/lib-golden_spiral.md index 204925e8..5539091c 100644 --- a/docs/lib-golden_spiral.md +++ b/docs/lib-golden_spiral.md @@ -6,8 +6,8 @@ It returns a vector of `[[x, y], angle]`. ## Parameters -- `from` : If any ray from the origin intersects two successive turnings of the spiral, we'll have two points. The `arm_distance` is the distance between these two points. -- `to` : In polar coordinates `(r, θ)` Archimedean spiral can be described by the equation `r = bθ ` where `θ` is measured in radians. For being consistent with OpenSCAD, the function here use degrees. The `init_angle` is which angle the first point want to start. +- `from` : The nth Fibonacci number you wanna start from. +- `to` : The nth Fibonacci number you wanna go to. - `point_distance` : Distance between two points on the path. - `rt_dir` : `"CT_CLK"` for counterclockwise. `"CLK"` for clockwise. The default value is `"CT_CLK"`.