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.

Sign up for GitHub

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

Jump to bottom

Clarify AStarGrid2D.is_in_bounds functionality #82724

Merged
merged 1 commit into from
Oct 3, 2023
Merged

Clarify AStarGrid2D.is_in_bounds functionality #82724

merged 1 commit into from
Oct 3, 2023

Conversation

AThousandShips
Copy link
Member

@AThousandShips AThousandShips added enhancement documentation topic:2d cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release labels Oct 3, 2023
@AThousandShips AThousandShips added this to the 4.2 milestone Oct 3, 2023
@AThousandShips AThousandShips requested a review from a team as a code owner October 3, 2023 12:26
@AThousandShips AThousandShips mentioned this pull request Oct 3, 2023
Closed
@AThousandShips
Copy link
Member Author

Felt a link to Rect2i.has_point was unnecessary here though it does have some quirks in what it includes and not, the purpose was more to clarify that it only considers region and not other properties

@akien-mga akien-mga removed the topic:2d label Oct 3, 2023
@kleonc
Copy link
Member

kleonc commented Oct 3, 2023

Clarify AStarGrid2D.is_in_bounds functionality

Currently this PR updates the docs for AStarGrid2D.is_in_boundsv but there's also a separate AStarGrid2D.is_in_bounds method, its docs should be updated too.

@AThousandShips
Copy link
Member Author

Will do, thought it'd be excessive to add to both, as they are connected, but better be thorough

@kleonc
Copy link
Member

kleonc commented Oct 3, 2023

Will do, thought it'd be excessive to add to both, as they are connected, but better be thorough

For a short description duplication should be fine. If description would be longer then it would indeed make sense to make one of them e.g. something like "Equivalent of ... but taking ... as argument(s).".

@akien-mga akien-mga merged commit 954a3b3 into godotengine:master Oct 3, 2023
@akien-mga
Copy link
Member

Thanks!

@AThousandShips AThousandShips deleted the grid_doc branch October 3, 2023 15:42
@AThousandShips
Copy link
Member Author

Thank you!

@YuriSizov YuriSizov removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Jan 23, 2024
@YuriSizov
Copy link
Contributor

Cherry-picking for 4.1.4 would affect translations, so since this is a clarification and not a fix for some mistake, I'd keep the descriptions as is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kleonc kleonc kleonc approved these changes

@akien-mga akien-mga akien-mga approved these changes

Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
4.2
Development

Successfully merging this pull request may close these issues.

AStartGrid2D is_in_bounds() does not account for offset
4 participants
@AThousandShips @kleonc @akien-mga @YuriSizov