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

Fix wrong return type mention in AStarGrid2D docs #89862

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

brandtware
Copy link
Contributor

@brandtware brandtware commented Mar 24, 2024

The docs for AStarGrid2D say that they would return a PackedVector3Array while inside a thread but the typing for that function is PackedVector2Array. This fixes the Typo

@brandtware brandtware requested a review from a team as a code owner March 24, 2024 18:52
@AThousandShips AThousandShips changed the title Fixed typo Fixed typo in AStarGrid2D Mar 24, 2024
@AThousandShips
Copy link
Member

Please amend your commit message to be more detailed, the new name of the PR would be good

@AThousandShips AThousandShips added bug documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Mar 24, 2024
@AThousandShips AThousandShips added this to the 4.3 milestone Mar 24, 2024
@AThousandShips
Copy link
Member

I mean the message of your commit, not the text of the PR, you need to do:

git commit --amend

And change the message

@AThousandShips
Copy link
Member

You need to push with git push -f, you've merged both branches into one, so please do:

git reset --hard a8e6160
git push -f

@AThousandShips
Copy link
Member

Sorry that message isn't very clear, please change it to the title of this PR, or something else short :)

@brandtware
Copy link
Contributor Author

@AThousandShips thank you for your assistance 👍

@AThousandShips
Copy link
Member

It should be:

Fixed typo in AStarGrid2D

The docs for AStarGrid2D say that they would return a PackedVector3Array while inside a thread but the typing for that function is PackedVector2Array. This fixes the Typo

The title needs to be at the top :) Sorry for the finicky thing to solve

@brandtware
Copy link
Contributor Author

ok... maybe this time -.-

@AThousandShips
Copy link
Member

There!

@akien-mga akien-mga changed the title Fixed typo in AStarGrid2D Fix wrong return type mention in AStarGrid2D docs Mar 24, 2024
@timothyqiu
Copy link
Member

Just my two cents: It's unnecessary to explicitly mention the type here. The function signature already contains the return type 😛

it will return an empty array

@akien-mga
Copy link
Member

Just my two cents: It's unnecessary to explicitly mention the type here. The function signature already contains the return type 😛

it will return an empty array

Pushed an update with that change for all three classes.

@akien-mga akien-mga merged commit abd64bd into godotengine:master Apr 4, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@akien-mga akien-mga removed cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Apr 8, 2024
@akien-mga
Copy link
Member

Cherry-picked for 4.2.2.

@akien-mga
Copy link
Member

Cherry-picked for 4.1.4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AStarGrid2D get_point_path would return a PackedVector -> 3 <- Array
5 participants