From dd274dc48bf716c2de20b29420aa175e8949404c Mon Sep 17 00:00:00 2001 From: BD103 <59022059+BD103@users.noreply.github.com> Date: Mon, 8 Apr 2024 21:19:49 -0400 Subject: [PATCH 1/2] fix: beta doc lints in task pool I chose to remove the extended documentation for `TaskPool::executor`. It references `TaskPoolInner` which was added in #384 when `bevy_tasks` was first created, but that struct was later removed in #2250. James may be able to rewrite the comment, but I do not know enough about the task pool to write anything. --- crates/bevy_tasks/src/task_pool.rs | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs index 300373031ad42..1e58f128ca2ec 100644 --- a/crates/bevy_tasks/src/task_pool.rs +++ b/crates/bevy_tasks/src/task_pool.rs @@ -37,7 +37,7 @@ pub struct TaskPoolBuilder { /// If set, we'll use the given stack size rather than the system default stack_size: Option, /// Allows customizing the name of the threads - helpful for debugging. If set, threads will - /// be named (), i.e. "MyThreadPool (2)" + /// be named ` ()`, i.e. `"MyThreadPool (2)"`. thread_name: Option, on_thread_spawn: Option>, @@ -106,14 +106,10 @@ impl TaskPoolBuilder { /// will still execute a task, even if it is dropped. #[derive(Debug)] pub struct TaskPool { - /// The executor for the pool - /// - /// 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 executor for the pool. executor: Arc>, - /// Inner state of the pool + // The inner state of the pool. threads: Vec>, shutdown_tx: async_channel::Sender<()>, } From eba3812c07208472d5b03e48ed253dc4dabf7968 Mon Sep 17 00:00:00 2001 From: BD103 <59022059+BD103@users.noreply.github.com> Date: Mon, 8 Apr 2024 21:50:59 -0400 Subject: [PATCH 2/2] fix: bugged redundant link to `App` --- crates/bevy_winit/src/winit_config.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/bevy_winit/src/winit_config.rs b/crates/bevy_winit/src/winit_config.rs index 3400e86ba27da..412a795a115ba 100644 --- a/crates/bevy_winit/src/winit_config.rs +++ b/crates/bevy_winit/src/winit_config.rs @@ -58,6 +58,8 @@ impl Default for WinitSettings { } } +// Rustdoc mistakenly believes `App` is already in scope. +#[allow(rustdoc::redundant_explicit_links)] /// Determines how frequently an [`App`](bevy_app::App) should update. /// /// **Note:** This setting is independent of VSync. VSync is controlled by a window's