Clarify documentation for Geometry2D.line_intersects_line #92001
+28
−2
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
Calinou
added
enhancement
documentation
cherrypick:4.2
Mickeon
reviewed
May 19, 2024
|
These are good suggestions, thanks guys. I'll clean things up a bit and push changes. I was struggling w/ the pre-commit hooks so I've been focused on that but now I've got it working (at least locally) so I'll go back and review this stuff |
GrahameGW
force-pushed
the
line_intersect_docs
branch
from
149c65f
to
b17935d
Compare
GrahameGW
force-pushed
the
line_intersect_docs
branch
from
724e3fa
to
bbf3582
Compare
|
I was asked in another PR to change the commit name to the PR name so I've done that here |
GrahameGW
force-pushed
the
line_intersect_docs
branch
from
bbf3582
to
f7eb16c
Compare
|
Squashed the various issues I had w/ git into a single commit as per the preferences of the godot team |
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.
line_intersects_line has parameters
fromanddirto define each line that implies the intersecting lines are rays (rather infinite lines, which they actually are). As this caused me confusion, I wrote some clarifying examples and attempted to improve this description. It would also be a good idea to rename these parameters fromfromanddirtopointandsloperespectively to further eliminate this confusion, and even further amend this description to point users to a function that does check rays for intersection.