Skip to content

Commit

Permalink
Clean up advice on glob imports in style guide (bevyengine#4644)
Browse files Browse the repository at this point in the history
# 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 bevyengine#4608.
  • Loading branch information
alice-i-cecile authored and ItsDoot committed Feb 1, 2023
1 parent c8c806d commit e22c7c9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/contributing/engine_style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e22c7c9

Please sign in to comment.