mirror of
https://github.com/bevyengine/bevy
synced 2024-12-28 22:13:08 +00:00
6ec6a55645
# Objective
- Crate-level prelude modules, such as `bevy_ecs::prelude`, are plagued
with inconsistency! Let's fix it!
## Solution
Format all preludes based on the following rules:
1. All preludes should have brief documentation in the format of:
> The _name_ prelude.
>
> This includes the most common types in this crate, re-exported for
your convenience.
2. All documentation should be outer, not inner. (`///` instead of
`//!`.)
3. No prelude modules should be annotated with `#[doc(hidden)]`. (Items
within them may, though I'm not sure why this was done.)
## Testing
- I manually searched for the term `mod prelude` and updated all
occurrences by hand. 🫠
---------
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| cluster | ||
| deferred | ||
| light | ||
| light_probe | ||
| lightmap | ||
| meshlet | ||
| prepass | ||
| render | ||
| ssao | ||
| ssr | ||
| volumetric_fog | ||
| bundle.rs | ||
| extended_material.rs | ||
| fog.rs | ||
| lib.rs | ||
| material.rs | ||
| parallax.rs | ||
| pbr_material.rs | ||
| wireframe.rs | ||