From 5ff3e6ad9f770bd31194eac642c682c68eccf361 Mon Sep 17 00:00:00 2001 From: HactarCE <6060305+HactarCE@users.noreply.github.com> Date: Thu, 19 Sep 2024 21:10:21 -0400 Subject: [PATCH] Document `puzzle.axes:add()` return value --- docs/hsc/lua/puzzle-construction/axes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hsc/lua/puzzle-construction/axes.md b/docs/hsc/lua/puzzle-construction/axes.md index 124bdde..57246a5 100644 --- a/docs/hsc/lua/puzzle-construction/axes.md +++ b/docs/hsc/lua/puzzle-construction/axes.md @@ -29,9 +29,9 @@ The axis system has no fields. #### `puzzle.axes:add()` -`puzzle.axes:add()` adds a [twist axis](axes.md) to the axis system, optionally adding [layers](twists.md#layer-system) to it and slicing the puzzle on each layer boundary. It takes two arguments: a [vector](../geometry/blade.md#vectors) for the new twist axis, and an optional table containing additional arguments. +`puzzle.axes:add()` adds a [twist axis](axes.md) to the axis system, optionally adding [layers](twists.md#layer-system) to it and slicing the puzzle on each layer boundary. It takes two arguments: a [vector](../geometry/blade.md#vectors) for the new twist axis, and an optional table containing additional arguments. The new axis is returned. -If the vector is an [orbit](../geometry/orbit.md) of [vectors](../geometry/blade.md#vectors) instead of just a single one, then `puzzle.axes:add()` will add an axis for each vector, all with the same layers. If the orbit has [names assigned](../geometry/orbit.md#orbitnamed), then the new axes created by the cut will be assigned those names. +If the vector is an [orbit](../geometry/orbit.md) of [vectors](../geometry/blade.md#vectors) instead of just a single one, then `puzzle.axes:add()` will add an axis for each vector, all with the same layers. If the orbit has [names assigned](../geometry/orbit.md#orbitnamed), then the new axes created by the cut will be assigned those names. An orbit of the new axes is returned. The table may contain two optional keys: