From accfb33ab982e4e9a994e20b0d3239651e3eab3d Mon Sep 17 00:00:00 2001
From: Michael Dorst <m@mdorst.net>
Date: Thu, 30 Dec 2021 09:08:19 +0000
Subject: [PATCH] Fix `doc_markdown` lints in `bevy_app` (#3467)

#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.
---
 crates/bevy_app/src/app.rs             | 14 +++++++-------
 crates/bevy_app/src/plugin.rs          |  4 ++--
 crates/bevy_app/src/schedule_runner.rs |  4 ++--
 3 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs
index 04024d794a4d3..a9788252802d5 100644
--- a/crates/bevy_app/src/app.rs
+++ b/crates/bevy_app/src/app.rs
@@ -500,11 +500,11 @@ impl App {
         self
     }
 
-    /// Adds a new [State] with the given `initial` value.
-    /// This inserts a new `State<T>` resource and adds a new "driver" to [CoreStage::Update].
+    /// Adds a new [`State`] with the given `initial` value.
+    /// 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
-    /// 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.
+    /// 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.
     pub fn add_state<T>(&mut self, initial: T) -> &mut Self
     where
         T: StateData,
@@ -512,10 +512,10 @@ impl App {
         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.
     /// 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.
     pub fn add_state_to_stage<T>(&mut self, stage: impl StageLabel, initial: T) -> &mut Self
     where
@@ -759,7 +759,7 @@ impl App {
     /// Adds a group of plugins
     ///
     /// 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`.
     ///
diff --git a/crates/bevy_app/src/plugin.rs b/crates/bevy_app/src/plugin.rs
index 38115af2ced49..c1e791b1e08dd 100644
--- a/crates/bevy_app/src/plugin.rs
+++ b/crates/bevy_app/src/plugin.rs
@@ -3,8 +3,8 @@ use std::any::Any;
 
 /// A collection of Bevy App logic and configuration
 ///
-/// Plugins configure an [App](crate::App). When an [App](crate::App) registers
-/// a plugin, the plugin's [Plugin::build] function is run.
+/// Plugins configure an [`App`](crate::App). When an [`App`](crate::App) registers
+/// a plugin, the plugin's [`Plugin::build`] function is run.
 pub trait Plugin: Any + Send + Sync {
     fn build(&self, app: &mut App);
     fn name(&self) -> &str {
diff --git a/crates/bevy_app/src/schedule_runner.rs b/crates/bevy_app/src/schedule_runner.rs
index c3a897d5eced1..526d4008f0344 100644
--- a/crates/bevy_app/src/schedule_runner.rs
+++ b/crates/bevy_app/src/schedule_runner.rs
@@ -45,8 +45,8 @@ impl ScheduleRunnerSettings {
     }
 }
 
-/// Configures an App to run its [Schedule](bevy_ecs::schedule::Schedule) according to a given
-/// [RunMode]
+/// Configures an `App` to run its [`Schedule`](bevy_ecs::schedule::Schedule) according to a given
+/// [`RunMode`]
 #[derive(Default)]
 pub struct ScheduleRunnerPlugin;