bevy/crates/bevy_reflect/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
..
enums Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
impls Fix ci xvfb (#11143) 2023-12-30 09:07:31 +00:00
path Fix some nightly warnings (#9672) 2023-09-02 18:35:06 +00:00
serde Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
array.rs Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
fields.rs reflect: TypePath part 2 (#8768) 2023-10-09 19:33:03 +00:00
from_reflect.rs reflect: TypePath part 2 (#8768) 2023-10-09 19:33:03 +00:00
lib.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
list.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
map.rs Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
reflect.rs delete methods deprecated in 0.12 (#10693) 2023-11-24 16:15:47 +00:00
std_traits.rs fix nightly clippy warnings (#6395) 2022-10-28 21:03:01 +00:00
struct_trait.rs Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
tuple.rs Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
tuple_struct.rs Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
type_info.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
type_path.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
type_registry.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
type_uuid.rs bevy_utils: Export generate_composite_uuid utility function (#10496) 2023-11-25 23:21:35 +00:00
type_uuid_impl.rs Re-export smallvec crate from bevy_utils (#11006) 2023-12-24 15:35:09 +00:00
utility.rs Removed once_cell (#10079) 2023-10-12 10:20:07 +00:00