Clarify the results of VectorN.normalized() in the docs
#92707
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RedMser
reviewed
Jun 3, 2024
AThousandShips
added
enhancement
documentation
cherrypick:4.1
GrahameGW
force-pushed
the
vector_normalized_docs
branch
from
a0d3b67 to
bbf1a7f
Compare
AThousandShips
approved these changes
Jun 3, 2024
|
Fixed space typo and adjusted vector format to (0, 0) from (0,0)-- thanks guys for the review |
AThousandShips
changed the title
VectorN.normalized() in the docs
|
Could you please update the commit message to match the PR title? |
GrahameGW
force-pushed
the
vector_normalized_docs
branch
from
bbf1a7f to
0560e89
Compare
Yep, all set |
|
Thanks! And congrats for your first merged Godot contribution 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation for
VectorN.normalized()does not explicitly state what happens if you normalize a zero-length vector. As there are at least two logical outcomes (a divide by zero error orVectorN.Zero), it is worth it to specify how godot handles this case; something which is potentially further confused by the note RE potential odd behavior when the vector length is very small.This change simply adds the clarifying note that normalizing a zero-length vector will return
(0,0),(0,0,0), or(0,0,0,0), depending on the vector size normalized.