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

[Merged by Bors] - Rename shapes examples for consistency #6082

Closed
wants to merge 2 commits into from

Conversation

rparrett
Copy link
Contributor

@rparrett rparrett commented Sep 24, 2022

Objective

I was about to submit a PR to add these two examples to bevy-website and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

Solution

Rename shapes to 2d_shapes. Now the filename matches the example name, and the naming structure matches the 3d example.

Notes

@Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.

@rparrett rparrett added C-Examples An addition or correction to our examples C-Code-Quality A section of code that is hard to understand or change labels Sep 24, 2022
@alice-i-cecile
Copy link
Member

Merging as trivial :)

bors r+

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Sep 24, 2022
bors bot pushed a commit that referenced this pull request Sep 24, 2022
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.
@bors
Copy link
Contributor

bors bot commented Sep 24, 2022

Build failed:

@mockersf
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Sep 24, 2022
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.
@bors
Copy link
Contributor

bors bot commented Sep 24, 2022

Build failed:

@mockersf
Copy link
Member

mockersf commented Sep 24, 2022

example name need to be renamed here too:

xvfb-run cargo run -p build-wasm-example -- --browsers chromium --browsers firefox --frames 25 --test shapes lighting text_debug breakout

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

bors r+

bors bot pushed a commit that referenced this pull request Sep 25, 2022
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.
@bors bors bot changed the title Rename shapes examples for consistency [Merged by Bors] - Rename shapes examples for consistency Sep 25, 2022
@bors bors bot closed this Sep 25, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 19, 2022
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency.

Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list  because the names are very prominent.

This also helps out when fuzzy-searching the codebase for these files.

## Solution

Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example.

## Notes

@Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Code-Quality A section of code that is hard to understand or change C-Examples An addition or correction to our examples 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.

3 participants