From 94ffa21d7770298098d781cd9f9ab75293c49319 Mon Sep 17 00:00:00 2001 From: Nicola Papale Date: Thu, 3 Aug 2023 15:22:59 +0200 Subject: [PATCH] Fix doc warning in bevy_tasks --- crates/bevy_tasks/src/single_threaded_task_pool.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/bevy_tasks/src/single_threaded_task_pool.rs b/crates/bevy_tasks/src/single_threaded_task_pool.rs index 2e47468b8e8db2..29bae6154dabcf 100644 --- a/crates/bevy_tasks/src/single_threaded_task_pool.rs +++ b/crates/bevy_tasks/src/single_threaded_task_pool.rs @@ -5,7 +5,7 @@ thread_local! { static LOCAL_EXECUTOR: async_executor::LocalExecutor<'static> = async_executor::LocalExecutor::new(); } -/// Used to create a TaskPool +/// Used to create a [`TaskPool`]. #[derive(Debug, Default, Clone)] pub struct TaskPoolBuilder {} @@ -24,7 +24,7 @@ impl<'a> ThreadExecutor<'a> { } impl TaskPoolBuilder { - /// Creates a new TaskPoolBuilder instance + /// Creates a new `TaskPoolBuilder` instance pub fn new() -> Self { Self::default() } @@ -76,7 +76,7 @@ impl TaskPool { 1 } - /// Allows spawning non-'static futures on the thread pool. The function takes a callback, + /// Allows spawning non-`'static` futures on the thread pool. The function takes a callback, /// passing a scope object into it. The scope object provided to the callback can be used /// to spawn tasks. This function will await the completion of all tasks before returning. /// @@ -89,7 +89,7 @@ impl TaskPool { self.scope_with_executor(false, None, f) } - /// Allows spawning non-`static futures on the thread pool. The function takes a callback, + /// Allows spawning non-`'static` futures on the thread pool. The function takes a callback, /// passing a scope object into it. The scope object provided to the callback can be used /// to spawn tasks. This function will await the completion of all tasks before returning. ///