bevy/crates/bevy_tasks/src
Doonv 189ceaf0d3
Replace or document ignored doctests (#11040)
# Objective

There are a lot of doctests that are `ignore`d for no documented reason.
And that should be fixed.

## Solution

I searched the bevy repo with the regex ` ```[a-z,]*ignore ` in order to
find all `ignore`d doctests. For each one of the `ignore`d doctests, I
did the following steps:
1. Attempt to remove the `ignored` attribute while still passing the
test. I did this by adding hidden dummy structs and imports.
2. If step 1 doesn't work, attempt to replace the `ignored` attribute
with the `no_run` attribute while still passing the test.
3. If step 2 doesn't work, keep the `ignored` attribute but add
documentation for why the `ignored` attribute was added.

---------

Co-authored-by: François <mockersf@gmail.com>
2024-01-01 16:50:56 +00:00
..
iter Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
lib.rs Re-export futures_lite in bevy_tasks (#10670) 2023-11-21 16:51:13 +00:00
single_threaded_task_pool.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
slice.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
task_pool.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
task.rs
thread_executor.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
usages.rs