docs: the returned geometries are not always new

Author: platypii

packages/modeling/src/operations/booleans/intersect.js

@@ -8,12 +8,12 @@ import intersectGeom2 from './intersectGeom2.js'
 import intersectGeom3 from './intersectGeom3.js'
 
 /**
- * Return a new geometry representing space in both the first geometry and
+ * Return a geometry representing space in both the first geometry and
  * all subsequent geometries.
  * The given geometries should be of the same type, either geom2 or geom3.
  *
  * @param {...Object} geometries - list of geometries
- * @returns {geom2|geom3} a new geometry
+ * @returns {geom2|geom3} a geometry
  * @alias module:modeling/booleans.intersect
  *
  * @example

packages/modeling/src/operations/booleans/intersectGeom2.js

@@ -4,10 +4,10 @@ import { INTERSECTION } from './martinez/operation.js'
 import boolean from './martinez/index.js'
 
 /*
- * Return a new 2D geometry representing space in both the first geometry and
+ * Return a 2D geometry representing space in both the first geometry and
  * in the subsequent geometries. None of the given geometries are modified.
  * @param {...geom2} geometries - list of 2D geometries
- * @returns {geom2} new 2D geometry
+ * @returns {geom2} a 2D geometry
  */
 export const intersectGeom2 = (...geometries) => {
   geometries = flatten(geometries)

packages/modeling/src/operations/booleans/intersectGeom3.js

@@ -5,10 +5,10 @@ import retessellate from '../modifiers/retessellate.js'
 import intersectSub from './intersectGeom3Sub.js'
 
 /*
- * Return a new 3D geometry representing space in both the first geometry and
+ * Return a 3D geometry representing space in both the first geometry and
  * in the subsequent geometries. None of the given geometries are modified.
  * @param {...geom3} geometries - list of 3D geometries
- * @returns {geom3} new 3D geometry
+ * @returns {geom3} a 3D geometry
  */
 export const intersectGeom3 = (...geometries) => {
   geometries = flatten(geometries)

packages/modeling/src/operations/booleans/intersectGeom3Sub.js

@@ -5,11 +5,11 @@ import { Tree } from './trees/index.js'
 import mayOverlap from './mayOverlap.js'
 
 /*
- * Return a new 3D geometry representing the space in both the first geometry and
+ * Return a 3D geometry representing the space in both the first geometry and
  * the second geometry. None of the given geometries are modified.
  * @param {geom3} geometry1 - a geometry
  * @param {geom3} geometry2 - a geometry
- * @returns {geom3} new 3D geometry
+ * @returns {geom3} a 3D geometry
  */
 export const intersectGeom3Sub = (geometry1, geometry2) => {
   if (!mayOverlap(geometry1, geometry2)) {

packages/modeling/src/operations/booleans/subtract.js

@@ -8,12 +8,12 @@ import subtractGeom2 from './subtractGeom2.js'
 import subtractGeom3 from './subtractGeom3.js'
 
 /**
- * Return a new geometry representing space in the first geometry but
+ * Return a geometry representing space in the first geometry but
  * not in all subsequent geometries.
  * The given geometries should be of the same type, either geom2 or geom3.
  *
  * @param {...Object} geometries - list of geometries
- * @returns {geom2|geom3} a new geometry
+ * @returns {geom2|geom3} a geometry
  * @alias module:modeling/booleans.subtract
  *
  * @example

packages/modeling/src/operations/booleans/subtractGeom2.js

@@ -4,10 +4,10 @@ import { DIFFERENCE } from './martinez/operation.js'
 import boolean from './martinez/index.js'
 
 /*
- * Return a new 2D geometry representing space in the first geometry but
+ * Return a 2D geometry representing space in the first geometry but
  * not in the subsequent geometries. None of the given geometries are modified.
  * @param {...geom2} geometries - list of geometries
- * @returns {geom2} new 2D geometry
+ * @returns {geom2} a 2D geometry
  */
 export const subtractGeom2 = (...geometries) => {
   geometries = flatten(geometries)

packages/modeling/src/operations/booleans/subtractGeom3.js

@@ -5,10 +5,10 @@ import retessellate from '../modifiers/retessellate.js'
 import subtractSub from './subtractGeom3Sub.js'
 
 /*
- * Return a new 3D geometry representing space in this geometry but not in the given geometries.
+ * Return a 3D geometry representing space in this geometry but not in the given geometries.
  * Neither this geometry nor the given geometries are modified.
  * @param {...geom3} geometries - list of geometries
- * @returns {geom3} new 3D geometry
+ * @returns {geom3} a 3D geometry
  */
 export const subtractGeom3 = (...geometries) => {
   geometries = flatten(geometries)

packages/modeling/src/operations/booleans/subtractGeom3Sub.js

@@ -5,11 +5,11 @@ import { Tree } from './trees/index.js'
 import mayOverlap from './mayOverlap.js'
 
 /*
- * Return a new 3D geometry representing the space in the first geometry but not
+ * Return a 3D geometry representing the space in the first geometry but not
  * in the second geometry. None of the given geometries are modified.
  * @param {geom3} geometry1 - a geometry
  * @param {geom3} geometry2 - a geometry
- * @returns {geom3} new 3D geometry
+ * @returns {geom3} a 3D geometry
  */
 export const subtractGeom3Sub = (geometry1, geometry2) => {
   if (!mayOverlap(geometry1, geometry2)) {

packages/modeling/src/operations/booleans/union.js

@@ -8,11 +8,11 @@ import unionGeom2 from './unionGeom2.js'
 import unionGeom3 from './unionGeom3.js'
 
 /**
- * Return a new geometry representing the total space in the given geometries.
+ * Return a geometry representing the total space in the given geometries.
  * The given geometries should be of the same type, either geom2 or geom3.
  *
  * @param {...Object} geometries - list of geometries
- * @returns {geom2|geom3} a new geometry
+ * @returns {geom2|geom3} a geometry
  * @alias module:modeling/booleans.union
  *
  * @example

packages/modeling/src/operations/booleans/unionGeom2.js

@@ -4,9 +4,9 @@ import { UNION } from './martinez/operation.js'
 import boolean from './martinez/index.js'
 
 /*
- * Return a new 2D geometry representing the total space in the given 2D geometries.
+ * Return a 2D geometry representing the total space in the given 2D geometries.
  * @param {...geom2} geometries - list of 2D geometries to union
- * @returns {geom2} new 2D geometry
+ * @returns {geom2} a 2D geometry
  */
 export const unionGeom2 = (...geometries) => {
   geometries = flatten(geometries)