Document custom symmetries and transformable regions

Hypercubers · Aug 2, 2024 · 14a8d55 · 14a8d55
1 parent 5ce5265
commit 14a8d55
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/hsc/lua/geometry/symmetry.md b/docs/hsc/lua/geometry/symmetry.md
@@ -44,6 +44,12 @@ This diagram describes the Coxeter groups graphically, with labels representing
 
 ![Finite Coxeter groups](https://assets.hypercubing.xyz/img/dev/cd-indices.png)
 
+### `symmetry()`
+
+`symmetry()` constructs a group from generators. It takes a single argument: a sequential table of generator [transforms](transform.md). [Twists](../puzzle-construction/twists.md) are automatically converted to transforms.
+
+The fields `.mirror_vectors`, `.chiral`, and `.is_chiral` and the method `:vec()` are not supported on symmetries constructed using `symmetry()`.
+
 ## Fields
 
 Symmetries have the following fields:

diff --git a/docs/hsc/lua/geometry/transform.md b/docs/hsc/lua/geometry/transform.md
@@ -12,6 +12,7 @@ A **transform** is a combination of some sequence of translations, rotations, an
 [point]: blade.md#points
 [vector]: blade.md#vectors
 [hyperplane]: hyperplane.md
+[region]: region.md
 
 ## Why not matrices?
 
@@ -113,6 +114,7 @@ Below is a list of all types that can be transformed:
 
 - [Blades][blade], including [vectors][vector] and [points][point]
 - [Hyperplanes][hyperplane]
+- [Regions][region]
 - Other transforms
 - [Axes](../puzzle-construction/axes.md)
 - [Colors](../puzzle-construction/colors.md)