mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
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.
This commit is contained in:
parent
5ca78b1e27
commit
241a61d2a5
1 changed files with 1 additions and 1 deletions
2
.github/contributing/engine_style_guide.md
vendored
2
.github/contributing/engine_style_guide.md
vendored
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue