Skip to content

Commit 652d404

Browse files
committed
minor copyedits to smooth_path documentation
1 parent d466c36 commit 652d404

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

rounding.scad

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -605,32 +605,32 @@ function _rounding_offsets(edgespec,z_dir=1) =
605605
// Description:
606606
// Smooths the input path, creating a continuous curve using a cubic spline, using one of two methods.
607607
// .
608-
// For `method="edges"`, every segment of the path is replaced by a cubic curve with `splinesteps` points,
608+
// For `method="edges"`, every segment (edge) of the path is replaced by a cubic curve with `splinesteps` points,
609609
// and the cubic interpolation passes through every input point on the path, matching the tangents at every
610610
// point. If you do not specify `tangents`, they are computed using path_tangents with `uniform=false` by
611611
// default. Only the dirction of a tangent vector matters, not the vector length.
612612
// Setting `uniform=true` with non-uniform sampling may be desirable in some cases but tends to
613613
// produces curves that overshoot the point on the path.
614614
// .
615615
// For `method="corners"`, every corner of the path is replaced by two cubic curves, each with
616-
// `splinesteps` points. The two curves are joined at the corner bisector, and the cubic interpolation
617-
// is tangent to the midpoint of every segment.
618-
// The `tangents` and `uniform` parameters don't apply to the "corners" method. Using `tangents` with "corners" causes an error.
616+
// `splinesteps` points. The two curves are joined at the corner bisector, and the cubic interpolations
617+
// are tangent to the midpoint of every segment. The `tangents` and `uniform` parameters don't apply to the
618+
// "corners" method. Using `tangents` with "corners" causes an error.
619619
// .
620620
// The `size` or `relsize` parameters apply to both methods. They determine how far the curve can bend away
621621
// from the input path. In the case where the path has three non-collinear points, the size specifies the
622622
// exact distance between the specified path and the curve (maximum distance from edge if for the "edges"
623623
// method, or distance from corner with the "corners" method).
624-
// In 2d when the spline may make an S-curve, for the "edges" method the size parameter specifies the sum
624+
// In 2D when the spline may make an S-curve, for the "edges" method the size parameter specifies the sum
625625
// of the deviations of the two peaks of the curve. In 3-space the bezier curve may have three extrema: two
626626
// maxima and one minimum. In this case the size specifies the sum of the maxima minus the minimum.
627627
// .
628628
// If you give `relsize` instead, then for the "edges" method, the maximum deviation from the segment is
629629
// relative to the segment length (e.g. 0.05 means 5% of the segment length). For the "corners" method,
630-
// `relsize` determines where the curve intersects the corner bisector relative to the maximum deviation
630+
// `relsize` determines where the curve intersects the corner bisector, relative to the maximum deviation
631631
// possible (which corresponds to a circle rounding from the shortest leg of the corner). For example,
632-
// `relsize=1` is the maximum deviation from the corner, and `relsize=0.5` causes the curve to intersect the
633-
// corner bisector halfway between the maximum and the tip of the corner.
632+
// `relsize=1` is the maximum deviation from the corner (a circle arc from the shortest leg), and `relsize=0.5`
633+
// causes the curve to intersect the corner bisector halfway between the maximum and the tip of the corner.
634634
// .
635635
// At a given segment or corner (depending on the method) there is a maximum size: a size value that is too
636636
// large is rounded down. See also path_to_bezpath().

0 commit comments

Comments
 (0)