2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2025-01-07 10:48:57 +00:00
bevy/crates/bevy_app
BD103 6ec6a55645
Unify crate-level preludes ()
# 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>
2024-09-08 17:10:57 +00:00
..
src Unify crate-level preludes () 2024-09-08 17:10:57 +00:00
Cargo.toml bevy_reflect: Function registry () 2024-08-06 01:09:48 +00:00
README.md add and fix shields in Readmes () 2023-10-15 00:52:31 +00:00

Bevy App

License Crates.io Downloads Docs Discord

This crate is about everything concerning the highest-level, application layer of a Bevy app.