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.

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

Clarify the difference between default render layers and none render layers #14075

Merged

Conversation

joseph-gio
Copy link
Member

@joseph-gio joseph-gio commented Jun 30, 2024

Objective

It's not always obvious what the default value for RenderLayers represents. It is documented, but since it's an implementation of a trait method the documentation may or may not be shown depending on the IDE.

Solution

Add documentation to the none method that explicitly calls out the difference.

@joseph-gio joseph-gio added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen C-Code-Quality A section of code that is hard to understand or change labels Jun 30, 2024
Copy link
Contributor

Your PR increases Bevy Minimum Supported Rust Version. Please update the rust-version field in the root Cargo.toml file.

@janhohenheim janhohenheim added D-Trivial Nice and easy! A great choice to get started with Bevy X-Uncontroversial This work is generally agreed upon S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jun 30, 2024
@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-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jun 30, 2024
@alice-i-cecile alice-i-cecile added this to the 0.14 milestone Jul 1, 2024
@alice-i-cecile alice-i-cecile enabled auto-merge July 1, 2024 14:35
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jul 1, 2024
Merged via the queue into bevyengine:main with commit 9055fc1 Jul 1, 2024
31 checks passed
@joseph-gio joseph-gio deleted the clarify-render-layer-none branch July 1, 2024 15:51
mockersf pushed a commit that referenced this pull request Jul 2, 2024
…r layers (#14075)

# Objective

It's not always obvious what the default value for `RenderLayers`
represents. It is documented, but since it's an implementation of a
trait method the documentation may or may not be shown depending on the
IDE.

## Solution

Add documentation to the `none` method that explicitly calls out the
difference.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
zmbush pushed a commit to zmbush/bevy that referenced this pull request Jul 3, 2024
…r layers (bevyengine#14075)

# Objective

It's not always obvious what the default value for `RenderLayers`
represents. It is documented, but since it's an implementation of a
trait method the documentation may or may not be shown depending on the
IDE.

## Solution

Add documentation to the `none` method that explicitly calls out the
difference.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
MrGVSV pushed a commit to MrGVSV/bevy that referenced this pull request Jul 5, 2024
…r layers (bevyengine#14075)

# Objective

It's not always obvious what the default value for `RenderLayers`
represents. It is documented, but since it's an implementation of a
trait method the documentation may or may not be shown depending on the
IDE.

## Solution

Add documentation to the `none` method that explicitly calls out the
difference.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation 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 X-Uncontroversial This work is generally agreed upon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants