Note that diff, intersect and conv_hull invoke children repeatedly

This commit is contained in:
Adrian Mariano 2023-06-30 16:01:19 -04:00
parent 9cbfa540bd
commit efde869e63

View file

@ -942,6 +942,8 @@ module tag_scope(scope){
// better to give it a tag that is not a remove tag or a keep tag. Such an object *will* be subject to
// subtractions from other remove-tagged objects.
// .
// Note that `diff()` invokes its children three times.
// .
// For a step-by-step explanation of attachments, see the [Attachments Tutorial](Tutorial-Attachments).
// Arguments:
// remove = String containing space delimited set of tag names of children to difference away. Default: `"remove"`
@ -1196,6 +1198,8 @@ module tag_diff(tag,remove="remove", keep="keep")
// unioned with the result. Attachable objects should be tagged using {{tag()}}
// and non-attachable objects with {{force_tag()}}.
// .
// Note that `intersect()` invokes its children three times.
// .
// For a step-by-step explanation of attachments, see the [Attachments Tutorial](Tutorial-Attachments).
// Arguments:
// intersect = String containing space delimited set of tag names of children to intersect. Default: "intersect"
@ -1313,6 +1317,8 @@ module tag_intersect(tag,intersect="intersect",keep="keep")
// not tagged with the `keep` tags are combined into a convex hull, and the children tagged with the keep tags
// are unioned with the result.
// .
// Note that `conv_hull()` invokes its children twice.
// .
// For a step-by-step explanation of attachments, see the [Attachments Tutorial](Tutorial-Attachments).
// Arguments:
// keep = String containing space delimited set of tag names of children to keep out of the hull. Default: "keep"