Skip to content

Commit

Permalink
Merge pull request #92707 from GrahameGW/vector_normalized_docs
Browse files Browse the repository at this point in the history
Clarify the results of `VectorN.normalized()` in the docs
  • Loading branch information
akien-mga committed Jun 4, 2024
2 parents 62b1523 + 0560e89 commit 2f26842
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/classes/Vector2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@
<method name="normalized" qualifiers="const">
<return type="Vector2" />
<description>
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized].
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized].
[b]Note:[/b] This function may return incorrect values if the input vector length is near zero.
</description>
</method>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Vector3.xml
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@
<method name="normalized" qualifiers="const">
<return type="Vector3" />
<description>
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized].
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized].
[b]Note:[/b] This function may return incorrect values if the input vector length is near zero.
</description>
</method>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Vector4.xml
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@
<method name="normalized" qualifiers="const">
<return type="Vector4" />
<description>
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized].
Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0, 0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized].
[b]Note:[/b] This function may return incorrect values if the input vector length is near zero.
</description>
</method>
Expand Down

0 comments on commit 2f26842

Please sign in to comment.