From b672465047148b753aca369f8cf82299f4fa33ea Mon Sep 17 00:00:00 2001 From: targrub Date: Wed, 2 Nov 2022 16:47:40 +0000 Subject: [PATCH] Fix doctest warnings (#6447) # Objective - Fixes doctest warnings from upcoming Rust release. ` cargo doc --workspace --all-features --no-deps --document-private-items` using `beta-x86_64-pc-windows-msvc (default) rustc 1.66.0-beta.1 (e080cc5a6 2022-11-01)` was giving warnings on a few comments. ## Solution - Quoted the Rust code parts. --- crates/bevy_input/src/keyboard.rs | 2 +- crates/bevy_tasks/src/task_pool.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/bevy_input/src/keyboard.rs b/crates/bevy_input/src/keyboard.rs index e2080aae79..e2d174b6a5 100644 --- a/crates/bevy_input/src/keyboard.rs +++ b/crates/bevy_input/src/keyboard.rs @@ -431,7 +431,7 @@ pub enum KeyCode { /// /// ## Usage /// -/// It is used as the generic value of an [`Input`](crate::Input) to create a `Res>`. +/// It is used as the generic `` value of an [`Input`](crate::Input) to create a `Res>`. /// The resource values are mapped to the physical location of a key on the keyboard and correlate to an [`KeyCode`](KeyCode) /// /// ## Updating diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs index d15a9e6ff2..d2f5c05cbe 100644 --- a/crates/bevy_tasks/src/task_pool.rs +++ b/crates/bevy_tasks/src/task_pool.rs @@ -68,9 +68,9 @@ impl TaskPoolBuilder { pub struct TaskPool { /// The executor for the pool /// - /// This has to be separate from TaskPoolInner because we have to create an Arc to + /// This has to be separate from TaskPoolInner because we have to create an `Arc` to /// pass into the worker threads, and we must create the worker threads before we can create - /// the Vec> contained within TaskPoolInner + /// the `Vec>` contained within `TaskPoolInner` executor: Arc>, /// Inner state of the pool