bevy/crates/bevy_render/src/render_resource
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
..
batched_uniform_buffer.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
bind_group_entries.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
bind_group_layout_entries.rs Replace or document ignored doctests (#11040) 2024-01-01 16:50:56 +00:00
bind_group_layout.rs Replace UUID based IDs with a atomic-counted ones (#6988) 2022-12-25 00:23:15 +00:00
bind_group.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
buffer_vec.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
buffer.rs Replace UUID based IDs with a atomic-counted ones (#6988) 2022-12-25 00:23:15 +00:00
gpu_array_buffer.rs Bind group layout entries (#10224) 2023-11-28 04:00:49 +00:00
mod.rs Misc cleanup (#11134) 2023-12-30 23:27:48 +00:00
pipeline_cache.rs Update to wgpu 0.18 (#10266) 2023-12-14 02:45:47 +00:00
pipeline_specializer.rs added multi-line string formatting (#8350) 2023-04-13 18:00:17 +00:00
pipeline.rs Add push contant config to layout (#7681) 2023-02-17 06:20:16 +00:00
resource_macros.rs Enable clippy::undocumented_unsafe_blocks warning across the workspace (#10646) 2023-11-21 02:06:24 +00:00
shader.rs Fix shader import hot reloading on windows (#10502) 2023-11-11 23:01:08 +00:00
storage_buffer.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00
texture.rs Add screenshot api (#7163) 2023-04-19 21:28:42 +00:00
uniform_buffer.rs Remove unnecessary path prefixes (#10749) 2023-11-28 23:43:40 +00:00