Skip to content

Commit 7668fae

Browse files
authored
Apply suggestions from code review
1 parent 6475070 commit 7668fae

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

content/en-us/reference/engine/libraries/vector.yaml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ type: library
33
summary: |
44
A library of vector functions.
55
description: |
6-
This library implements functionality for the vector type in addition to the built-in primitive operator support. It uses vectors with 3 components (x, y, and z).
6+
This library implements functionality for the vector type in addition to the built-in primitive operator support. It uses vectors with three components (`x`, `y`, and `z`).
77
8-
Individual vector components can be accessed using the fields x or X, y or Y, z or Z. Since vector values are immutable, writes to individual components are not supported.
8+
Individual vector components can be accessed using the fields `x` or `X`, `y` or `Y`, `z` or `Z`. Since vector values are immutable, writing to individual components is not supported.
99
code_samples:
1010
properties:
1111
- name: vector.zero
1212
type: vector
13-
summary: Constant vector with all components set to 0.
14-
description: Constant vector with all components set to 0.
13+
summary: Constant vector with all components set to `0`.
14+
description: Constant vector with all components set to `0`.
1515
tags:
1616
code_samples:
1717
- name: vector.one
1818
type: vector
19-
summary: Constant vector with all components set to 1.
20-
description: Constant vector with all components set to 1.
19+
summary: Constant vector with all components set to `1`.
20+
description: Constant vector with all components set to `1`.
2121
tags:
2222
code_samples:
2323
functions:
@@ -125,8 +125,8 @@ functions:
125125
tags:
126126
code_samples:
127127
- name: vector.floor
128-
summary: Applies `math.floor` to every component of the input vector.
129-
description: Applies `math.floor` to every component of the input vector.
128+
summary: Applies `Library.math.floor()` to every component of the input vector.
129+
description: Applies `Library.math.floor()` to every component of the input vector.
130130
parameters:
131131
- name: vec
132132
type: vector
@@ -138,8 +138,8 @@ functions:
138138
tags:
139139
code_samples:
140140
- name: vector.ceil
141-
summary: Applies `math.ceil` to every component of the input vector.
142-
description: Applies `math.ceil` to every component of the input vector.
141+
summary: Applies `Library.math.ceil()` to every component of the input vector.
142+
description: Applies `Library.math.ceil()` to every component of the input vector.
143143
parameters:
144144
- name: vec
145145
type: vector
@@ -151,8 +151,8 @@ functions:
151151
tags:
152152
code_samples:
153153
- name: vector.abs
154-
summary: Applies `math.abs` to every component of the input vector.
155-
description: Applies `math.abs` to every component of the input vector.
154+
summary: Applies `Library.math.abs()` to every component of the input vector.
155+
description: Applies `Library.math.abs()` to every component of the input vector.
156156
parameters:
157157
- name: vec
158158
type: vector
@@ -164,8 +164,8 @@ functions:
164164
tags:
165165
code_samples:
166166
- name: vector.sign
167-
summary: Applies `math.sign` to every component of the input vector.
168-
description: Applies `math.sign` to every component of the input vector.
167+
summary: Applies `Library.math.sign()` to every component of the input vector.
168+
description: Applies `Library.math.sign()` to every component of the input vector.
169169
parameters:
170170
- name: vec
171171
type: vector
@@ -177,8 +177,8 @@ functions:
177177
tags:
178178
code_samples:
179179
- name: vector.clamp
180-
summary: Applies `math.clamp` to every component of the input vector.
181-
description: Applies `math.clamp` to every component of the input vector.
180+
summary: Applies `Library.math.clamp()` to every component of the input vector.
181+
description: Applies `Library.math.clamp()` to every component of the input vector.
182182
parameters:
183183
- name: vec
184184
type: vector
@@ -198,9 +198,9 @@ functions:
198198
tags:
199199
code_samples:
200200
- name: vector.max
201-
summary: Applies `math.max` to the corresponding components of the input vectors.
201+
summary: Applies `Library.math.max()` to the corresponding components of the input vectors.
202202
description: |
203-
Applies `math.max` to the corresponding components of the input vectors. Equivalent to `vector.create(math.max((...).x), math.max((...).y), math.max((...).z))`.
203+
Applies `Library.math.max()` to the corresponding components of the input vectors.
204204
parameters:
205205
- name: ...
206206
type: vector
@@ -212,9 +212,9 @@ functions:
212212
tags:
213213
code_samples:
214214
- name: vector.min
215-
summary: Applies `math.min` to the corresponding components of the input vectors.
215+
summary: Applies `Library.math.min()` to the corresponding components of the input vectors.
216216
description: |
217-
Applies `math.min` to the corresponding components of the input vectors. Equivalent to `vector.create(math.min((...).x), math.min((...).y), math.min((...).z))`.
217+
Applies `Library.math.min()` to the corresponding components of the input vectors.
218218
parameters:
219219
- name: ...
220220
type: vector

0 commit comments

Comments
 (0)