bevy/crates/bevy_tasks/src
Hans Meine 1abb6b0758
elaborate on TaskPool and bevy tasks (#8750)
# Objective

I found it very difficult to understand how bevy tasks work, and I
concluded that the documentation should be improved for beginners like
me.

## Solution

These changes to the documentation were written from my beginner's
perspective after
some extremely helpful explanations by nil on Discord.

I am not familiar enough with rustdoc yet; when looking at the source, I
found the documentation at the very top of `usages.rs` helpful, but I
don't know where they are rendered. They should probably be linked to
from the main `bevy_tasks` README.

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Mike <mike.hsu@gmail.com>
2023-08-11 21:07:28 +00:00
..
iter small and mostly pointless refactoring (#2934) 2022-02-13 22:33:55 +00:00
lib.rs opt-out multi-threaded feature flag (#9269) 2023-08-03 07:47:09 +00:00
single_threaded_task_pool.rs Fix doc warning in bevy_tasks (#9348) 2023-08-05 13:53:05 +00:00
slice.rs Document bevy_tasks and enable #![warn(missing_docs)] (#3509) 2022-01-16 04:53:22 +00:00
task.rs Add is_finished to Task<T> (#6444) 2022-11-02 12:27:22 +00:00
task_pool.rs elaborate on TaskPool and bevy tasks (#8750) 2023-08-11 21:07:28 +00:00
thread_executor.rs fix clippy::default_constructed_unit_structs and trybuild errors (#9144) 2023-07-13 22:23:04 +00:00
usages.rs elaborate on TaskPool and bevy tasks (#8750) 2023-08-11 21:07:28 +00:00