Skip to content

Fix inaccurate comment in custom_ui_material.wgsl shader#16846

Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom
pin3-free:fix-custom-ui-material-comments
Dec 17, 2024
Merged

Fix inaccurate comment in custom_ui_material.wgsl shader#16846
alice-i-cecile merged 2 commits intobevyengine:mainfrom
pin3-free:fix-custom-ui-material-comments

Conversation

@pin3-free
Copy link
Copy Markdown
Contributor

Objective

Solution

  • Changed the comment.

Testing

  • Testing is not relevant to fixing comments (as long as the comment is accurate)

@github-actions
Copy link
Copy Markdown
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@alice-i-cecile alice-i-cecile changed the title Fixed the inaccurate comment Fix inaccurate comment in custom_ui_material.wgsl shader Dec 16, 2024
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy C-Examples An addition or correction to our examples A-UI Graphical user interfaces, styles, layouts, and widgets S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Dec 16, 2024
Copy link
Copy Markdown
Contributor

@rparrett rparrett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an improvement, but to me it sounds like it is claiming some responsibility in the shader for stuff that is happening in rust code in the example.

The shader is just responsible for drawing the bar according to those material properties that are modified there.

This distinction is sort of relevant to #16829 actually, because this sort of animation could be done in the shader, and people probably want to know how to do that, but that's not what's going on here at the moment.

@pin3-free
Copy link
Copy Markdown
Contributor Author

This is an improvement, but to me it sounds like it is claiming some responsibility in the shader for stuff that is happening in rust code in the example.

The shader is just responsible for drawing the bar according to those material properties that are modified there.

This distinction is sort of relevant to #16829 actually, because this sort of animation could be done in the shader, and people probably want to know how to do that, but that's not what's going on here at the moment.

So it's better to describe as "The shader draws a progress bar in accordance with the data from the game/rust side of the game"?

@alice-i-cecile alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Dec 16, 2024
@rparrett
Copy link
Copy Markdown
Contributor

rparrett commented Dec 16, 2024

Maybe something like

Draws a progress bar with properties defined in `CustomUiMaterial`

@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Dec 16, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Dec 17, 2024
Merged via the queue into bevyengine:main with commit 3cd649b Dec 17, 2024
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Jan 6, 2025
…16846)

# Objective

- Modify a comment in the shader file to describe what the shader
actually does
- Fixes bevyengine#16830

## Solution

- Changed the comment.

## Testing

- Testing is not relevant to fixing comments (as long as the comment is
accurate)

---------

Co-authored-by: Freya Pines <[email protected]>
Co-authored-by: Freya Pines <[email protected]>
mrchantey pushed a commit to mrchantey/bevy that referenced this pull request Feb 4, 2025
…16846)

# Objective

- Modify a comment in the shader file to describe what the shader
actually does
- Fixes bevyengine#16830

## Solution

- Changed the comment.

## Testing

- Testing is not relevant to fixing comments (as long as the comment is
accurate)

---------

Co-authored-by: Freya Pines <[email protected]>
Co-authored-by: Freya Pines <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-UI Graphical user interfaces, styles, layouts, and widgets C-Examples An addition or correction to our examples D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comments in custom_ui_material.wgsl are outdated

4 participants