Skip to content

Commit

Permalink
Fix doc warning in bevy_tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
nicopap committed Aug 3, 2023
1 parent 4209819 commit 94ffa21
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions crates/bevy_tasks/src/single_threaded_task_pool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}

Expand All @@ -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()
}
Expand Down Expand Up @@ -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.
///
Expand All @@ -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.
///
Expand Down

0 comments on commit 94ffa21

Please sign in to comment.