[Merged by Bors] - Document PipelineCache and related types
#5600
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
Add documenting comments to `PipelineCache` and a few other related types in the same file.
alice-i-cecile
added
C-Docs
Member
|
Two small concerns, then this LGTM. |
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Contributor
Author
|
@alice-i-cecile for final (?) review after all fixed, thanks! |
Contributor
Author
|
Tiny rant : changes like #3979 that introduced a large part of this code should not have been allowed to merge without a single comment on the entire file. I don't know if there's a policy now, but if there's none I'd like to suggest raising the bar a bit and strongly suggesting (if not requiring) at least a minimal documenting of new features. |
alice-i-cecile
approved these changes
Aug 7, 2022
Member
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
@bevyengine/rendering-team can I get a review from one of y'all? I'm happy with this from a docs perspective but not fully confident about the domain specific content.
cart
reviewed
Aug 8, 2022
Member
cart
left a comment
cart
left a comment
There was a problem hiding this comment.
Generally looks good. Just one comment
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
djeedai
added
the
S-Ready-For-Final-Review
Member
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Sep 2, 2022
# Objective Document `PipelineCache` and a few other related types. ## Solution Add documenting comments to `PipelineCache` and a few other related types in the same file.
Contributor
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
PipelineCache and related typesPipelineCache and related types
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
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
# Objective Document `PipelineCache` and a few other related types. ## Solution Add documenting comments to `PipelineCache` and a few other related types in the same file.
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
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective Document `PipelineCache` and a few other related types. ## Solution Add documenting comments to `PipelineCache` and a few other related types in the same file.
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
Document
PipelineCacheand a few other related types.Solution
Add documenting comments to
PipelineCacheand a few other relatedtypes in the same file.