From 11afabf252cd90a09c1cc0af154fbc027231384c Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 2 Apr 2020 20:21:50 +0800 Subject: [PATCH] update docs --- docs/lib2x-function_grapher.md | 4 ++-- docs/lib2x-sf_solidify.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/lib2x-function_grapher.md b/docs/lib2x-function_grapher.md index c3259e78..fc09a1ce 100644 --- a/docs/lib2x-function_grapher.md +++ b/docs/lib2x-function_grapher.md @@ -1,10 +1,10 @@ # function_grapher -Given a set of points `[x, y, f(x, y)]` where `f(x, y)` is a mathematics function, the `function_grapher` module can create the graph of `f(x, y)`. +Given a list of points `[x, y, f(x, y)]` where `f(x, y)` is a mathematics function, the `function_grapher` module can create the graph of `f(x, y)`. ## Parameters -- `points` : A set of points `[x, y, f(x, y)]`. See examples below. +- `points` : A list of points `[x, y, f(x, y)]`. See examples below. - `thickness` : The face or line thickness. - `style` : The style of the graph. It accepts `"FACES"`, `"LINES"`, `"HULL_FACES"` and `"HULL_LINES"`. The default value is `"FACES"` which simply takes `f(x, y) - thickness` for each point to build a bottom. It may cause thickness problems when slopes is high. The `"HULL_FACES"` value can solve the problem but is slow. When assigning `"LINES"`, it uses lines to connect points. The `"HULL_LINES"` is very very slow; however, the model might look smoother if you have a small `$fn`. - `slicing` : Given a rectangle, we have two ways to slice it into two triangles. Using this parameter to determine the way you want. It accepts `"SLASH"` (default) and `"BACK_SLASH"`. diff --git a/docs/lib2x-sf_solidify.md b/docs/lib2x-sf_solidify.md index d57d3998..9ae67884 100644 --- a/docs/lib2x-sf_solidify.md +++ b/docs/lib2x-sf_solidify.md @@ -1,13 +1,13 @@ # sf_solidify -It solidifies two square surfaces, described as a set of points `[x, y, z]`. +It solidifies two square surfaces, described as a list of points `[x, y, z]`. **Since:** 2.3 ## Parameters -- `surface1` : A list of numbers (0 ~ 255). -- `surface1` : The thickness of the model. +- `surface1` : A list of points `[x, y, z]`. +- `surface2` : A list of points `[x, y, z]`. - `slicing` : Given a rectangle, we have two ways to slice it into two triangles. Using this parameter to determine the way you want. It accepts `"SLASH"` (default) and `"BACK_SLASH"`. ## Examples