From 847c26b8dc194d6acbd75b03c756dd0b52d0c9ba Mon Sep 17 00:00:00 2001
From: Rob Parrett <robparrett@gmail.com>
Date: Sun, 25 Sep 2022 00:57:07 +0000
Subject: [PATCH] Rename shapes examples for consistency (#6082)

# 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 https://github.com/bevyengine/bevy/pull/4613#discussion_r862455631 but it had slipped away from my brain at that time.
---
 .github/workflows/validation-jobs.yml   | 10 +++++-----
 Cargo.toml                              | 10 +++++-----
 examples/2d/{shapes.rs => 2d_shapes.rs} |  0
 examples/3d/{shapes.rs => 3d_shapes.rs} |  0
 examples/README.md                      |  4 ++--
 5 files changed, 12 insertions(+), 12 deletions(-)
 rename examples/2d/{shapes.rs => 2d_shapes.rs} (100%)
 rename examples/3d/{shapes.rs => 3d_shapes.rs} (100%)

diff --git a/.github/workflows/validation-jobs.yml b/.github/workflows/validation-jobs.yml
index b97b669a7a..57d2a2f34c 100644
--- a/.github/workflows/validation-jobs.yml
+++ b/.github/workflows/validation-jobs.yml
@@ -41,7 +41,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-      
+
       - uses: actions/cache@v3
         with:
           path: |
@@ -51,13 +51,13 @@ jobs:
             ~/.cargo/git/db/
             target/
           key: ${{ runner.os }}-cargo-build-android-${{ hashFiles('**/Cargo.toml') }}
-      
+
       - name: Install Android targets
         run: rustup target add aarch64-linux-android armv7-linux-androideabi
-      
+
       - name: Install Cargo APK
         run: cargo install --force cargo-apk
-      
+
       - name: Build APK
         run: ANDROID_NDK_ROOT=$ANDROID_NDK_LATEST_HOME cargo apk build --example android_example
 
@@ -147,7 +147,7 @@ jobs:
           # start a webserver
           python3 -m http.server --directory examples/wasm &
 
-          xvfb-run cargo run -p build-wasm-example -- --browsers chromium --browsers firefox --frames 25 --test shapes lighting text_debug breakout
+          xvfb-run cargo run -p build-wasm-example -- --browsers chromium --browsers firefox --frames 25 --test 2d_shapes lighting text_debug breakout
 
       - name: Save screenshots
         uses: actions/upload-artifact@v3
diff --git a/Cargo.toml b/Cargo.toml
index 9d84500fd8..6612b16309 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -193,11 +193,11 @@ category = "2D Rendering"
 wasm = true
 
 [[example]]
-name = "shapes"
-path = "examples/2d/shapes.rs"
+name = "2d_shapes"
+path = "examples/2d/2d_shapes.rs"
 
-[package.metadata.example.shapes]
-name = "Shapes"
+[package.metadata.example.2d_shapes]
+name = "2D Shapes"
 description = "Renders a rectangle, circle, and hexagon"
 category = "2D Rendering"
 wasm = true
@@ -275,7 +275,7 @@ wasm = true
 
 [[example]]
 name = "3d_shapes"
-path = "examples/3d/shapes.rs"
+path = "examples/3d/3d_shapes.rs"
 
 [package.metadata.example.3d_shapes]
 name = "3D Shapes"
diff --git a/examples/2d/shapes.rs b/examples/2d/2d_shapes.rs
similarity index 100%
rename from examples/2d/shapes.rs
rename to examples/2d/2d_shapes.rs
diff --git a/examples/3d/shapes.rs b/examples/3d/3d_shapes.rs
similarity index 100%
rename from examples/3d/shapes.rs
rename to examples/3d/3d_shapes.rs
diff --git a/examples/README.md b/examples/README.md
index 7fe0929b7d..18853ac19d 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -88,11 +88,11 @@ Example | Description
 Example | Description
 --- | ---
 [2D Rotation](../examples/2d/rotation.rs) | Demonstrates rotating entities in 2D with quaternions
+[2D Shapes](../examples/2d/2d_shapes.rs) | Renders a rectangle, circle, and hexagon
 [Manual Mesh 2D](../examples/2d/mesh2d_manual.rs) | Renders a custom mesh "manually" with "mid-level" renderer apis
 [Mesh 2D](../examples/2d/mesh2d.rs) | Renders a 2d mesh
 [Mesh 2D With Vertex Colors](../examples/2d/mesh2d_vertex_color_texture.rs) | Renders a 2d mesh with vertex color attributes
 [Move Sprite](../examples/2d/move_sprite.rs) | Changes the transform of a sprite
-[Shapes](../examples/2d/shapes.rs) | Renders a rectangle, circle, and hexagon
 [Sprite](../examples/2d/sprite.rs) | Renders a sprite
 [Sprite Flipping](../examples/2d/sprite_flipping.rs) | Renders a sprite flipped along an axis
 [Sprite Sheet](../examples/2d/sprite_sheet.rs) | Renders an animated sprite
@@ -105,7 +105,7 @@ Example | Description
 Example | Description
 --- | ---
 [3D Scene](../examples/3d/3d_scene.rs) | Simple 3D scene with basic shapes and lighting
-[3D Shapes](../examples/3d/shapes.rs) | A scene showcasing the built-in 3D shapes
+[3D Shapes](../examples/3d/3d_shapes.rs) | A scene showcasing the built-in 3D shapes
 [Lighting](../examples/3d/lighting.rs) | Illustrates various lighting options in a simple scene
 [Lines](../examples/3d/lines.rs) | Create a custom material to draw 3d lines
 [Load glTF](../examples/3d/load_gltf.rs) | Loads and renders a glTF file as a scene