Skip to content

Commit

Permalink
Fix doc warning in bevy_tasks (#9348)
Browse files Browse the repository at this point in the history
# Objective

- `bevy_tasks` emits warnings under certain conditions

When I run `cargo clippy -p bevy_tasks` the warning doesn't show up,
while if I run it with `cargo clippy -p bevy_asset` the warning shows
up.

## Solution

- Fix the warnings.

## Longer term solution

We should probably fix CI so that those warnings do not slip through.
But that's not the goal of this PR.
  • Loading branch information
nicopap authored Aug 5, 2023
1 parent e1e2407 commit 60c6ca7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 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 Expand Up @@ -240,7 +240,8 @@ impl<'scope, 'env, T: Send + 'env> Scope<'scope, 'env, T> {
let result = Rc::new(RefCell::new(None));
self.results.borrow_mut().push(result.clone());
let f = async move {
result.borrow_mut().replace(f.await);
let temp_result = f.await;
result.borrow_mut().replace(temp_result);
};
self.executor.spawn(f).detach();
}
Expand Down

0 comments on commit 60c6ca7

Please sign in to comment.