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

Fix doc_markdown lints in bevy_app (#3467)

Browse Source 
#3457 adds the `doc_markdown` clippy lint, which checks doc comments to make sure code identifiers are escaped with backticks. This causes a lot of lint errors, so this is one of a number of PR's that will fix those lint errors one crate at a time.

This PR fixes lints in the `bevy_app` crate.
This commit is contained in:
Michael Dorst 2021-12-30 09:08:19 +00:00
parent d8d3fdf2cf
commit accfb33ab9
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -500,11 +500,11 @@ impl App {
self self
} }
/// Adds a new [State] with the given `initial` value. /// Adds a new [`State`] with the given `initial` value.
/// This inserts a new `State<T>` resource and adds a new "driver" to [CoreStage::Update]. /// This inserts a new `State<T>` resource and adds a new "driver" to [`CoreStage::Update`].
/// Each stage that uses `State<T>` for system run criteria needs a driver. If you need to use /// Each stage that uses `State<T>` for system run criteria needs a driver. If you need to use
/// your state in a different stage, consider using [Self::add_state_to_stage] or manually /// your state in a different stage, consider using [`Self::add_state_to_stage`] or manually
/// adding [State::get_driver] to additional stages you need it in. /// adding [`State::get_driver`] to additional stages you need it in.
pub fn add_state<T>(&mut self, initial: T) -> &mut Self pub fn add_state<T>(&mut self, initial: T) -> &mut Self
where where
T: StateData, T: StateData,
@ -512,10 +512,10 @@ impl App {
self.add_state_to_stage(CoreStage::Update, initial) self.add_state_to_stage(CoreStage::Update, initial)
} }
/// Adds a new [State] with the given `initial` value. /// Adds a new [`State`] with the given `initial` value.
/// This inserts a new `State<T>` resource and adds a new "driver" to the given stage. /// This inserts a new `State<T>` resource and adds a new "driver" to the given stage.
/// Each stage that uses `State<T>` for system run criteria needs a driver. If you need to use /// Each stage that uses `State<T>` for system run criteria needs a driver. If you need to use
/// your state in more than one stage, consider manually adding [State::get_driver] to the /// your state in more than one stage, consider manually adding [`State::get_driver`] to the
/// stages you need it in. /// stages you need it in.
pub fn add_state_to_stage<T>(&mut self, stage: impl StageLabel, initial: T) -> &mut Self pub fn add_state_to_stage<T>(&mut self, stage: impl StageLabel, initial: T) -> &mut Self
where where
@ -759,7 +759,7 @@ impl App {
/// Adds a group of plugins /// Adds a group of plugins
/// ///
/// Bevy plugins can be grouped into a set of plugins. Bevy provides /// Bevy plugins can be grouped into a set of plugins. Bevy provides
/// built-in PluginGroups that provide core engine functionality. /// built-in `PluginGroups` that provide core engine functionality.
/// ///
/// The plugin groups available by default are `DefaultPlugins` and `MinimalPlugins`. /// The plugin groups available by default are `DefaultPlugins` and `MinimalPlugins`.
/// ///

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

@ -3,8 +3,8 @@ use std::any::Any;
/// A collection of Bevy App logic and configuration /// A collection of Bevy App logic and configuration
/// ///
/// Plugins configure an [App](crate::App). When an [App](crate::App) registers /// Plugins configure an [`App`](crate::App). When an [`App`](crate::App) registers
/// a plugin, the plugin's [Plugin::build] function is run. /// a plugin, the plugin's [`Plugin::build`] function is run.
pub trait Plugin: Any + Send + Sync { pub trait Plugin: Any + Send + Sync {
fn build(&self, app: &mut App); fn build(&self, app: &mut App);
fn name(&self) -> &str { fn name(&self) -> &str {

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

@ -45,8 +45,8 @@ impl ScheduleRunnerSettings {
} }
} }
/// Configures an App to run its [Schedule](bevy_ecs::schedule::Schedule) according to a given /// Configures an `App` to run its [`Schedule`](bevy_ecs::schedule::Schedule) according to a given
/// [RunMode] /// [`RunMode`]
#[derive(Default)] #[derive(Default)]
pub struct ScheduleRunnerPlugin; pub struct ScheduleRunnerPlugin;