[Merged by Bors] - Make internal struct ShaderData non-pub
#5609
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
`ShaderData` is only used in `ShaderCache`, and the latter is private, so there is no need to make the former public. This change removes the `pub` keyword from `ShaderData`, hidding it as the implementation detail it is.
alice-i-cecile
added
A-Rendering
alice-i-cecile
approved these changes
Aug 7, 2022
alice-i-cecile
added
the
M-Needs-Migration-Guide
|
Technically a breaking change, but I don't think we want or need a migration guide. Can you add |
djeedai
changed the title
pubShaderData non-pub
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Aug 8, 2022
# Objective `ShaderData` is marked as public, but is an internal type only used by one other internal type, so it should be made private. ## Solution `ShaderData` is only used in `ShaderCache`, and the latter is private, so there is no need to make the former public. This change removes the `pub` keyword from `ShaderData`, hidding it as the implementation detail it is. Split from #5600
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
ShaderData non-pubShaderData non-pub
|
@alice-i-cecile we should have forced a CHANGELOG with a Migration Guide note section since this is a breaking change. Sorry I didn't think about it. Any idea if we could make that check automated? |
maccesch
pushed a commit
to Synphonyte/bevy
that referenced
this pull request
Sep 28, 2022
# Objective `ShaderData` is marked as public, but is an internal type only used by one other internal type, so it should be made private. ## Solution `ShaderData` is only used in `ShaderCache`, and the latter is private, so there is no need to make the former public. This change removes the `pub` keyword from `ShaderData`, hidding it as the implementation detail it is. Split from bevyengine#5600
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
# Objective `ShaderData` is marked as public, but is an internal type only used by one other internal type, so it should be made private. ## Solution `ShaderData` is only used in `ShaderCache`, and the latter is private, so there is no need to make the former public. This change removes the `pub` keyword from `ShaderData`, hidding it as the implementation detail it is. Split from bevyengine#5600
|
@djeedai do you think you can come up with a quick migration guide for this? You can either update the PR text or you can PR it to bevyengine/bevy-website#470 |
|
@IceSentry done, let me know if that's ok? |
|
Yep, should be good, I'll add it to the guide. |
|
Ok thanks for that! |
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective `ShaderData` is marked as public, but is an internal type only used by one other internal type, so it should be made private. ## Solution `ShaderData` is only used in `ShaderCache`, and the latter is private, so there is no need to make the former public. This change removes the `pub` keyword from `ShaderData`, hidding it as the implementation detail it is. Split from bevyengine#5600
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.
Objective
ShaderDatais marked as public, but is an internal type only used by one otherinternal type, so it should be made private.
Solution
ShaderDatais only used inShaderCache, and the latter is private,so there is no need to make the former public. This change removes the
pubkeyword fromShaderData, hidding it as the implementation detailit is.
Changelog
Removed
ShaderDatafrom the public API, which was only ever used internally. No public function was using it so there should be no need for any migration action.Split from #5600