[Merged by Bors] - Clarify index order in TextureAtlas::from_grid #6058
Conversation
This file contains hidden or 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
| /// Generate a `TextureAtlas` by splitting a texture into a grid where each | ||
| /// `tile_size` by `tile_size` grid-cell is one of the textures in the atlas | ||
| /// `tile_size` by `tile_size` grid-cell is one of the textures in the | ||
| /// atlas. Resulting TextureAtlas is indexed left to right, top to bottom. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// atlas. Resulting TextureAtlas is indexed left to right, top to bottom. | |
| /// atlas. The iteration order of the texture after splitting is left to right, top to bottom. |
Perhaps?
Contributor
Author
There was a problem hiding this comment.
What about 'The textures array in the resulting TextureAtlas is ordered left to right, top to bottom'?
Member
There was a problem hiding this comment.
I like the last wording proposed.
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Sep 22, 2022
Member
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
Merging as trivial :)
bors r+
alice-i-cecile
added
the
S-Ready-For-Final-Review
bors bot
pushed a commit
that referenced
this pull request
Sep 22, 2022
# Objective Docs on from_grid/from_grid_with_padding aren't clear on indexing order. ## Solution Make the docs better!
Contributor
|
Build failed: |
Member
|
bors retry |
bors bot
pushed a commit
that referenced
this pull request
Sep 22, 2022
# Objective Docs on from_grid/from_grid_with_padding aren't clear on indexing order. ## Solution Make the docs better!
Contributor
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 19, 2022
# Objective Docs on from_grid/from_grid_with_padding aren't clear on indexing order. ## Solution Make the docs better!
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
# Objective Docs on from_grid/from_grid_with_padding aren't clear on indexing order. ## Solution Make the docs better!
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective Docs on from_grid/from_grid_with_padding aren't clear on indexing order. ## Solution Make the docs better!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Objective
Docs on from_grid/from_grid_with_padding aren't clear on indexing order.
Solution
Make the docs better!