Skip to content

Commit addfa08

Browse files
committed
Making README the landing page and separating constructor methods
1 parent 82111f5 commit addfa08

4 files changed

Lines changed: 9 additions & 1 deletion

File tree

config.ld

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ no_return_or_parms = true
1414
topics = {
1515
'README.md',
1616
'CHANGELOG.md'
17-
}
17+
}
18+
19+
one = true

datapack/data/advanced_math/modules/pid.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,8 @@ local metatable = {
209209
__tostring = pid.tostring
210210
}
211211

212+
-- @section Constructors
213+
212214
--- Constructs a new PID controller for either a scalar, vector, or quaternion target.
213215
--
214216
-- @tparam number|vector|quaternion target The setpoint to reach

datapack/data/advanced_math/rom/apis/matrix.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,8 @@ local metatable = {
594594
__eq = matrix.equals
595595
}
596596

597+
-- @section Constructors
598+
597599
--- Constructs a new matrix of rows by columns, filling it using the provided function or scalar.
598600
--
599601
-- @tparam number rows The number of rows in the matrix

datapack/data/advanced_math/rom/apis/quaternion.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,8 @@ local vmetatable = {
368368
__eq = quaternion.equals,
369369
}
370370

371+
-- @section Constructors
372+
371373
--- Constructs a new quaternion from a vector and a w parameter. Similarly to fromComponents, this method will not produce a normalized quaternion.
372374
--
373375
-- @tparam Vector vec imaginary component of the vector, stored in a vector

0 commit comments

Comments
 (0)