From e22c7c9a6a6168ffb3af4f73ef4c738db557f766 Mon Sep 17 00:00:00 2001 From: Alice Cecile Date: Mon, 2 May 2022 18:45:00 +0000 Subject: [PATCH] Clean up advice on glob imports in style guide (#4644) # Objective - Example was misleading, as we never import `bevy` itself in the engine (except in integration tests). ## Solution - Clean up wording. ## Context Noticed by @mockersf in #4608. --- .github/contributing/engine_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/contributing/engine_style_guide.md b/.github/contributing/engine_style_guide.md index b19ad9120f5b5d..36b3781bd97dc9 100644 --- a/.github/contributing/engine_style_guide.md +++ b/.github/contributing/engine_style_guide.md @@ -6,7 +6,7 @@ For more advice on contributing to the engine, see the [relevant section](../../ ## General guidelines -1. Prefer granular imports over glob imports of `bevy::prelude::*` and `bevy::sub_crate::*`. +1. Prefer granular imports over glob imports like `bevy_ecs::prelude::*`. 2. Use a consistent comment style: 1. `///` doc comments belong above `#[derive(Trait)]` invocations. 2. `//` comments should generally go above the line in question, rather than in-line.