forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

More Doctest changes (#1405)

Browse Source 
* Add system() to DocTests

* Hide use statements
This commit is contained in:
MinerSebas 2021-02-06 02:44:34 +01:00 committed by GitHub
parent c87d4c110f
commit 3475a64a2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_app/src/app.rs
View File

@ -12,8 +12,8 @@ use bevy_utils::tracing::info_span;
/// ## Example /// ## Example
/// Here is a simple "Hello World" Bevy app: /// Here is a simple "Hello World" Bevy app:
/// ``` /// ```
///use bevy_app::prelude::*; ///# use bevy_app::prelude::*;
///use bevy_ecs::prelude::*; ///# use bevy_ecs::prelude::*;
/// ///
///fn main() { ///fn main() {
/// App::build() /// App::build()

12
crates/bevy_ecs/src/system/commands.rs
View File

@ -195,7 +195,7 @@ impl Commands {
/// # Example /// # Example
/// ///
/// ``` /// ```
/// use bevy_ecs::prelude::*; /// # use bevy_ecs::prelude::*;
/// ///
/// struct Component1; /// struct Component1;
/// struct Component2; /// struct Component2;
@ -206,7 +206,7 @@ impl Commands {
/// b: Component2, /// b: Component2,
/// } /// }
/// ///
/// fn example_system(mut commands: &mut Commands) { /// fn example_system(commands: &mut Commands) {
/// // Create a new entity with a component bundle. /// // Create a new entity with a component bundle.
/// commands.spawn(ExampleBundle { /// commands.spawn(ExampleBundle {
/// a: Component1, /// a: Component1,
@ -218,6 +218,8 @@ impl Commands {
/// // Create a new entity with two components. /// // Create a new entity with two components.
/// commands.spawn((Component1, Component2)); /// commands.spawn((Component1, Component2));
/// } /// }
///
/// # example_system.system();
/// ``` /// ```
pub fn spawn(&mut self, bundle: impl DynamicBundle + Send + Sync + 'static) -> &mut Self { pub fn spawn(&mut self, bundle: impl DynamicBundle + Send + Sync + 'static) -> &mut Self {
let entity = self let entity = self
@ -327,12 +329,12 @@ impl Commands {
/// `with` can be chained with [`Self::spawn`]. /// `with` can be chained with [`Self::spawn`].
/// ///
/// ``` /// ```
/// use bevy_ecs::prelude::*; /// # use bevy_ecs::prelude::*;
/// ///
/// struct Component1; /// struct Component1;
/// struct Component2; /// struct Component2;
/// ///
/// fn example_system(mut commands: Commands) { /// fn example_system(commands: &mut Commands) {
/// // Create a new entity with a `Component1` and `Component2`. /// // Create a new entity with a `Component1` and `Component2`.
/// commands.spawn((Component1,)).with(Component2); /// commands.spawn((Component1,)).with(Component2);
/// ///
@ -349,6 +351,8 @@ impl Commands {
/// b: Component2, /// b: Component2,
/// }); /// });
/// } /// }
///
/// # example_system.system();
/// ``` /// ```
pub fn with(&mut self, component: impl Component) -> &mut Self { pub fn with(&mut self, component: impl Component) -> &mut Self {
let current_entity = self.current_entity.expect("Cannot add component because the 'current entity' is not set. You should spawn an entity first."); let current_entity = self.current_entity.expect("Cannot add component because the 'current entity' is not set. You should spawn an entity first.");