bevy/crates/bevy_render/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
..
batching Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter (#10779) 2023-12-12 19:45:50 +00:00
camera Keep track of when a texture is first cleared (#10325) 2023-12-31 00:37:37 +00:00
color Replace deprecated elements (#10991) 2023-12-16 02:25:12 +00:00
mesh Document None conditions on compute_aabb (#11051) 2023-12-21 23:29:43 +00:00
primitives Add a method to compute a bounding box enclosing a set of points (#9630) 2023-08-31 01:33:13 +00:00
render_graph Reorder impl to be the same as the trait (#11076) 2023-12-24 17:43:55 +00:00
render_phase Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
render_resource Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
renderer Re-export smallvec crate from bevy_utils (#11006) 2023-12-24 15:35:09 +00:00
texture Keep track of when a texture is first cleared (#10325) 2023-12-31 00:37:37 +00:00
view Keep track of when a texture is first cleared (#10325) 2023-12-31 00:37:37 +00:00
extract_component.rs Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter (#10779) 2023-12-12 19:45:50 +00:00
extract_instances.rs Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter (#10779) 2023-12-12 19:45:50 +00:00
extract_param.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
extract_resource.rs Allow optional extraction of resources from the main world (#10109) 2023-10-14 16:07:49 +00:00
globals.rs Unify FixedTime and Time while fixing several problems (#8964) 2023-10-16 01:57:55 +00:00
globals.wgsl Refactor Globals and View structs into separate shaders (#7512) 2023-02-11 17:55:18 +00:00
gpu_component_array_buffer.rs Reorder render sets, refactor bevy_sprite to take advantage (#9236) 2023-08-27 14:33:49 +00:00
instance_index.wgsl Work around naga/wgpu WGSL instance_index -> GLSL gl_InstanceID bug on WebGL2 (#9383) 2023-08-09 18:38:45 +00:00
lib.rs Keep track of when a texture is first cleared (#10325) 2023-12-31 00:37:37 +00:00
maths.wgsl Use instancing for sprites (#9597) 2023-09-02 18:03:19 +00:00
pipelined_rendering.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
render_asset.rs Derive Error for more error types (#10240) 2023-10-28 22:20:37 +00:00
settings.rs Update to wgpu 0.18 (#10266) 2023-12-14 02:45:47 +00:00
spatial_bundle.rs Implement Clone for VisibilityBundle and SpatialBundle (#10394) 2023-11-07 21:25:00 +00:00