Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation for Geometry2D.line_intersects_line #92001

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

GrahameGW
Copy link
Contributor

line_intersects_line has parameters from and dir to 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 from from and dir to point and slope respectively to further eliminate this confusion, and even further amend this description to point users to a function that does check rays for intersection.

@GrahameGW GrahameGW requested a review from a team as a code owner May 15, 2024 23:37
@Calinou Calinou added enhancement documentation cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels May 15, 2024
@Calinou Calinou added this to the 4.3 milestone May 15, 2024
doc/classes/Geometry2D.xml Outdated Show resolved Hide resolved
doc/classes/Geometry2D.xml Outdated Show resolved Hide resolved
doc/classes/Geometry2D.xml Outdated Show resolved Hide resolved
@GrahameGW
Copy link
Contributor Author

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 GrahameGW force-pushed the line_intersect_docs branch from 149c65f to b17935d Compare May 19, 2024 17:13
@GrahameGW GrahameGW force-pushed the line_intersect_docs branch from 724e3fa to bbf3582 Compare June 3, 2024 21:22
@GrahameGW
Copy link
Contributor Author

I was asked in another PR to change the commit name to the PR name so I've done that here

@GrahameGW GrahameGW force-pushed the line_intersect_docs branch from bbf3582 to f7eb16c Compare June 5, 2024 17:26
@GrahameGW
Copy link
Contributor Author

Squashed the various issues I had w/ git into a single commit as per the preferences of the godot team

@AThousandShips AThousandShips modified the milestones: 4.3, 4.4 Jul 25, 2024
@AThousandShips AThousandShips added the cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release label Jul 25, 2024
@GrahameGW GrahameGW requested a review from Mickeon July 28, 2024 23:28
@GrahameGW
Copy link
Contributor Author

This has been sitting a bit but has all the requested changes. I re-requested a review; if there's a better way to do things let me know. Thanks!

Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep in mind most of us are doing this in our free time, too 😉

@GrahameGW
Copy link
Contributor Author

Of course--I figured there were higher priority things; I just wanted to make sure it didn't get lost in the shuffle. Thanks very much!

@akien-mga akien-mga changed the title Clarify documentation for Geometry2D.line_intersects_line Clarify documentation for Geometry2D.line_intersects_line Aug 16, 2024
@akien-mga akien-mga merged commit 7ac1f54 into godotengine:master Aug 16, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants