bevy/crates/bevy_ecs/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
..
entity Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
query Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
reflect Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
schedule Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
storage Fix ci xvfb (#11143) 2023-12-30 09:07:31 +00:00
system Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
world Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
archetype.rs Rename ArchetypeEntity::entity into ArchetypeEntity::id (#11118) 2024-01-01 16:12:24 +00:00
bundle.rs Allow #[derive(Bundle)] on tuple structs (take 3) (#10561) 2023-11-21 01:09:16 +00:00
change_detection.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
component.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
event.rs Explain EventWriter limits concurrency (#11063) 2023-12-24 17:45:21 +00:00
lib.rs Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter (#10779) 2023-12-12 19:45:50 +00:00
removal_detection.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00