Tweaked offset() description formatting.

This commit is contained in:
Revar Desmera 2019-07-16 15:18:00 -07:00
parent fadfd998cf
commit ad59d88ce2

View file

@ -810,24 +810,25 @@ function _offset_region(
// Function: offset() // Function: offset()
// //
// Description: // Description:
// Takes an input path and returns a path offset by the specified amount. As with the built-in offset() module, you can use // Takes an input path and returns a path offset by the specified amount. As with the built-in
// `r` to specify rounded offset and `delta` to specify offset with corners. Positive offsets shift the path // offset() module, you can use `r` to specify rounded offset and `delta` to specify offset with
// to the left (relative to the direction of the path). // corners. Positive offsets shift the path to the left (relative to the direction of the path).
// //
// When offsets shrink the path, segments cross and become invalid. By default `offset()` checks for this situation. // When offsets shrink the path, segments cross and become invalid. By default `offset()` checks
// To test validity the code checks that segments have distance larger than (r or delta) from the input path. // for this situation. To test validity the code checks that segments have distance larger than (r
// This check takes O(N^2) time and may mistakenly eliminate segments you wanted included in various situations, // or delta) from the input path. This check takes O(N^2) time and may mistakenly eliminate
// so you can disable it if you wish by setting check_valid=false. Another situation is that the test is not // segments you wanted included in various situations, so you can disable it if you wish by setting
// sufficiently thorough and some segments persist that should be eliminated. In this case, increase `quality` // check_valid=false. Another situation is that the test is not sufficiently thorough and some
// to 2 or 3. (This increases the number of samples on the segment that are checked.) Run time will increase. // segments persist that should be eliminated. In this case, increase `quality` to 2 or 3. (This
// In some situations you may be able to decrease run time by setting quality to 0, which causes only segment // increases the number of samples on the segment that are checked.) Run time will increase. In
// ends to be checked. // some situations you may be able to decrease run time by setting quality to 0, which causes only
// segment ends to be checked.
// //
// For construction of polyhedra `offset()` can also return face lists. These list faces between the // For construction of polyhedra `offset()` can also return face lists. These list faces between
// original path and the offset path where the vertices are ordered with the original path first, // the original path and the offset path where the vertices are ordered with the original path
// starting at `firstface_index` and the offset path vertices appearing afterwords. The direction // first, starting at `firstface_index` and the offset path vertices appearing afterwords. The
// of the faces can be flipped using `flip_faces`. When you request faces the return value // direction of the faces can be flipped using `flip_faces`. When you request faces the return
// is a list: [offset_path, face_list]. // value is a list: [offset_path, face_list].
// Arguments: // Arguments:
// path = the path to process. A list of 2d points. // path = the path to process. A list of 2d points.
// r = offset radius. Distance to offset. Will round over corners. // r = offset radius. Distance to offset. Will round over corners.