Skip to content

Commit

Permalink
docs : updated number2/3
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurVoxowl committed Feb 14, 2024
1 parent e456f7a commit 4704d6e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
4 changes: 3 additions & 1 deletion lua/docs/content/reference/number2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,10 @@ functions:
print(n1.X) -- n1.X is still 1
- name: "Normalize"
return:
- type: "Number2"
description: |
Normalizes the `Number2` so that its magnitude becomes `1.0`.
Normalizes the `Number2` so that its magnitude becomes `1.0`, and return it.
- name: "Lerp"
description: |
Expand Down
17 changes: 11 additions & 6 deletions lua/docs/content/reference/number3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -143,18 +143,21 @@ functions:
- name: "Angle"
description: |
Returns the angle in radians between this and given `Number3`.
Returns the angle in radians between this and given vector.
argument-sets:
-
- name: "eulerAnglesXYZ"
- name: "vector"
type: "Number3"
-
- name: "eulerAngleX"
- name: "vectorX"
type: "number"
- name: "eulerAngleY"
- name: "vectorY"
type: "number"
- name: "eulerAngleZ"
- name: "vectorZ"
type: "number"
-
- name: "vector"
type: "table of 3 numbers"
return:
- type: "number"

Expand Down Expand Up @@ -185,8 +188,10 @@ functions:
type: "number"

- name: "Normalize"
return:
- type: "Number3"
description: |
Normalizes the `Number3` so that its magnitude(/reference/number3#property-length) becomes `1.0`.
Normalizes the `Number3` so that its magnitude(/reference/number3#property-length) becomes `1.0`, and return it.
samples:
- code: |
local someNumber3 = Number3(10,0,0)
Expand Down

0 comments on commit 4704d6e

Please sign in to comment.