From 3bb19fbe2de22f54afaf31c65e6fba7997faf569 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Wed, 26 Apr 2017 21:12:37 +0800 Subject: [PATCH] updated docs --- docs/lib-polyline2d.md | 5 ++--- docs/lib-polyline3d.md | 2 +- docs/lib-rounded_cube.md | 4 ++-- docs/lib-rounded_square.md | 2 +- docs/lib-stereographic_extrude.md | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/lib-polyline2d.md b/docs/lib-polyline2d.md index fe327f9d..98d4e560 100644 --- a/docs/lib-polyline2d.md +++ b/docs/lib-polyline2d.md @@ -1,14 +1,13 @@ # polyline2d -Creates a polyline from a list of `x`, `y` coordinates. When the end points are `CAP_ROUND`, -* you can use `$fa`, `$fs` or `$fn` to controll the circle module used internally. It depends on the `line2d` module so you have to `include` line2d.scad. +Creates a polyline from a list of `x`, `y` coordinates. When the end points are `CAP_ROUND`, you can use `$fa`, `$fs` or `$fn` to controll the circle module used internally. It depends on the `line2d` module so you have to `include` line2d.scad. ## Parameters - `points` : The list of `[x, y]` points of the polyline. The points are indexed from 0 to n-1. - `width` : The line width. - `startingStyle` : The end-cap style of the starting point. The value must be `"CAP_BUTT"`, `"CAP_SQUARE"` or `"CAP_ROUND"`. The default value is `"CAP_SQUARE"`. -- endingStyle : The end-cap style of the ending point. The value must be `"CAP_BUTT"`, `"CAP_SQUARE"` or `"CAP_ROUND"`. The default value is `"CAP_SQUARE"`. +- `endingStyle` : The end-cap style of the ending point. The value must be `"CAP_BUTT"`, `"CAP_SQUARE"` or `"CAP_ROUND"`. The default value is `"CAP_SQUARE"`. - `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. The final fragments of a circle will be a multiple of 4 to fit edges if possible. ## Examples diff --git a/docs/lib-polyline3d.md b/docs/lib-polyline3d.md index 6f0b4387..ef6f1614 100644 --- a/docs/lib-polyline3d.md +++ b/docs/lib-polyline3d.md @@ -7,7 +7,7 @@ Creates a polyline from a list of `[x, y, z]` coordinates. It depends on the `li - `points` : The list of `[x, y, z]` points of the polyline. The points are indexed from 0 to n-1. - `thickness` : The line thickness. - `startingStyle` : The end-cap style of the starting point. The value must be `"CAP_BUTT"`, `"CAP_CIRCLE"` or `"CAP_SPHERE"`. The default value is `"CAP_CIRCL"`. -- endingStyle : The end-cap style of the ending point. The value must be `"CAP_BUTT"`, `"CAP_CIRCLE"` or `"CAP_SPHERE"`. The default value is `"CAP_CIRCLE"`. +- `endingStyle` : The end-cap style of the ending point. The value must be `"CAP_BUTT"`, `"CAP_CIRCLE"` or `"CAP_SPHERE"`. The default value is `"CAP_CIRCLE"`. - `$fa`, `$fs`, `$fn` : Used by the `circle` or `sphere` module internally. Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) or [the sphere module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Primitive_Solids#sphere) for more details. The final fragments of a circle will be a multiple of 4 to fit edges if possible. ## Examples diff --git a/docs/lib-rounded_cube.md b/docs/lib-rounded_cube.md index aa645b6d..ed36302a 100644 --- a/docs/lib-rounded_cube.md +++ b/docs/lib-rounded_cube.md @@ -1,13 +1,13 @@ # rounded_cube -Creates a cube in the first octant. When center is true, the cube is centered on the origin. +Creates a cube in the first octant. When `center` is `true`, the cube is centered on the origin. ## Parameters - `size` : Accepts a single value, cube with all sides this length. It also accepts 3 value array `[x, y, z]`, cube with dimensions `x`, `y` and `z`. - `corner_r` : The corner is one-eight of a sphere. The `corner_r` parameter determines the sphere radius. - `center` : `false` (default), 1st (positive) octant, one corner at (0,0,0). `true`, cube is centered at (0,0). -- `$fa`, `$fs`, `$fn` : Used to control the four quadrants. Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. The final fragments of a sphere will be a multiple of 4 to fit edges. +- `$fa`, `$fs`, `$fn` : Used to control the eight quadrants. Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. The final fragments of a sphere will be a multiple of 4 to fit edges. ## Examples diff --git a/docs/lib-rounded_square.md b/docs/lib-rounded_square.md index 3b49384a..eae5db1b 100644 --- a/docs/lib-rounded_square.md +++ b/docs/lib-rounded_square.md @@ -1,6 +1,6 @@ # rounded_square -Creates a rounded square or rectangle in the first quadrant. When center is true the square is centered on the origin. +Creates a rounded square or rectangle in the first quadrant. When `center` is `true` the square is centered on the origin. ## Parameters diff --git a/docs/lib-stereographic_extrude.md b/docs/lib-stereographic_extrude.md index 77d9977e..3b1f1b98 100644 --- a/docs/lib-stereographic_extrude.md +++ b/docs/lib-stereographic_extrude.md @@ -7,7 +7,7 @@ The 2D polygon should center at the origin and you have to determine the side le ## Parameters - `shadow_side_leng` : The side length of a square which can cover the 2D polygon. -- `$fa`, `$fs`, `$fn` : Check [the sphere module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Primitive_Solids#sphere for more details. +- `$fa`, `$fs`, `$fn` : Check [the sphere module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Primitive_Solids#sphere) for more details. ## Examples