Skip to content

Commit a9943e8

Browse files
authored
Fix beta CI (#12913)
# Objective - Fixes #12905. ## Solution - Use proper code `` tags for `TaskPoolBuilder::thread_name`. - Remove leftover documentation in `TaskPool` referencing the deleted `TaskPoolInner` struct. - It may be possible to rephrase this, but I do not know enough about the task pool to write something. (cc @james7132 who made the change removing `TaskPoolInner`.) - Ignore a buggy rustdoc lint that thinks `App` is already in scope for `UpdateMode` doc. (Extracted from #12692.)
1 parent 2f0b5b9 commit a9943e8

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

crates/bevy_tasks/src/task_pool.rs

+3-7
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pub struct TaskPoolBuilder {
3737
/// If set, we'll use the given stack size rather than the system default
3838
stack_size: Option<usize>,
3939
/// Allows customizing the name of the threads - helpful for debugging. If set, threads will
40-
/// be named <thread_name> (<thread_index>), i.e. "MyThreadPool (2)"
40+
/// be named `<thread_name> (<thread_index>)`, i.e. `"MyThreadPool (2)"`.
4141
thread_name: Option<String>,
4242

4343
on_thread_spawn: Option<Arc<dyn Fn() + Send + Sync + 'static>>,
@@ -106,14 +106,10 @@ impl TaskPoolBuilder {
106106
/// will still execute a task, even if it is dropped.
107107
#[derive(Debug)]
108108
pub struct TaskPool {
109-
/// The executor for the pool
110-
///
111-
/// This has to be separate from TaskPoolInner because we have to create an `Arc<Executor>` to
112-
/// pass into the worker threads, and we must create the worker threads before we can create
113-
/// the `Vec<Task<T>>` contained within `TaskPoolInner`
109+
/// The executor for the pool.
114110
executor: Arc<async_executor::Executor<'static>>,
115111

116-
/// Inner state of the pool
112+
// The inner state of the pool.
117113
threads: Vec<JoinHandle<()>>,
118114
shutdown_tx: async_channel::Sender<()>,
119115
}

crates/bevy_winit/src/winit_config.rs

+2
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ impl Default for WinitSettings {
5858
}
5959
}
6060

61+
// Rustdoc mistakenly believes `App` is already in scope.
62+
#[allow(rustdoc::redundant_explicit_links)]
6163
/// Determines how frequently an [`App`](bevy_app::App) should update.
6264
///
6365
/// **Note:** This setting is independent of VSync. VSync is controlled by a window's

0 commit comments

Comments
 (0)