diff options
| author | lawnjelly <lawnjelly@gmail.com> | 2023-03-13 12:48:05 +0000 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-03-16 16:46:18 +0100 |
| commit | c0e5879b41f99d690287bc4c696a8a217084e6ed (patch) | |
| tree | 670c3d175851bf4d151a41d37121d834db3a7bf9 /doc | |
| parent | 8e8ecf52cf084c845c3e0288861f166726ae9653 (diff) | |
Improve Vector2 / 3 / 4 normalized() classref.
Mention that the results will be unreliable with initial vector near zero.
(cherry picked from commit cca01afd82bd6e7b3e852a66ca459f5d61022585)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Vector2.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 1 | ||||
| -rw-r--r-- | doc/classes/Vector4.xml | 1 |
3 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index eeef694b98..8b48bd4c88 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -288,6 +288,7 @@ <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]. + [b]Note:[/b] This function may return incorrect values if the initial vector length is near zero. </description> </method> <method name="orthogonal" qualifiers="const"> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 8fd38a2415..91553c3acd 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -256,6 +256,7 @@ <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]. + [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> <method name="octahedron_decode" qualifiers="static"> diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 3b5b2e918e..880e6e4e19 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -191,6 +191,7 @@ <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]. + [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> <method name="posmod" qualifiers="const"> |