bevy/errors/src/lib.rs

//! Definitions of Bevy's error codes that might occur at runtime.
//!
//! These either manifest as a warning or a panic.

#[doc = include_str!("../B0001.md")]
pub struct B0001;

#[doc = include_str!("../B0002.md")]
pub struct B0002;

#[doc = include_str!("../B0003.md")]
pub struct B0003;

#[doc = include_str!("../B0004.md")]
pub struct B0004;
Add a `[lints]` entry for workspace members missing it (#11900) # Objective - Some workspace members do not inherit the global lints. ## Solution - Add a `[lints]` entry for all files returned by `rg --files-without-match -F "[lints]" **/Cargo.toml`, except the compile failure tests since these aren't part of the workspace. - Add some docstrings where needed. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> 2024-02-19 17:09:47 +00:00			`//! Definitions of Bevy's error codes that might occur at runtime.`
			`//!`
			`//! These either manifest as a warning or a panic.`

add detailed errors (#2994) # Objective - Improve error descriptions and help understand how to fix them - I noticed one today that could be expanded, it seemed like a good starting point ## Solution - Start something like https://github.com/rust-lang/rust/tree/master/compiler/rustc_error_codes/src/error_codes - Remove sentence about Rust mutability rules which is not very helpful in the error message I decided to start the error code with B for Bevy so that they're not confused with error code from rust (which starts with E) Longer term, there are a few more evolutions that can continue this: - the code samples should be compiled check, and even executed for some of them to check they have the correct error code in a panic - the error could be build on a page in the website like https://doc.rust-lang.org/error-index.html - most panic should have their own error code 2021-11-06 20:53:11 +00:00			`#[doc = include_str!("../B0001.md")]`
			`pub struct B0001;`

			`#[doc = include_str!("../B0002.md")]`
			`pub struct B0002;`
add a more helpful error to help debug panicking command on despawned entity (#5198) # Objective - Help users fix issue when their app panic when executing a command on a despawned entity ## Solution - Add an error code and a page describing how to debug the issue 2022-07-05 18:44:54 +00:00
			`#[doc = include_str!("../B0003.md")]`
			`pub struct B0003;`
Add warning when a hierarchy component is missing (#5590) # Objective A common pitfall since 0.8 is the requirement on `ComputedVisibility` being present on all ancestors of an entity that itself has `ComputedVisibility`, without which, the entity becomes invisible. I myself hit the issue and got very confused, and saw a few people hit it as well, so it makes sense to provide a hint of what to do when such a situation is encountered. - Fixes #5849 - Closes #5616 - Closes #2277 - Closes #5081 ## Solution We now check that all entities with both a `Parent` and a `ComputedVisibility` component have parents that themselves have a `ComputedVisibility` component. Note that the warning is only printed once. We also add a similar warning to `GlobalTransform`. This only emits a warning. Because sometimes it could be an intended behavior. Alternatives: - Do nothing and keep repeating to newcomers how to avoid recurring pitfalls - Make the transform and visibility propagation tolerant to missing components (#5616) - Probably archetype invariants, though the current draft would not allow detecting that kind of errors --- ## Changelog - Add a warning when encountering dubious component hierarchy structure Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com> 2022-09-19 16:12:11 +00:00
			`#[doc = include_str!("../B0004.md")]`
			`pub struct B0004;`