bevy/errors/Cargo.toml

[package]
name = "errors"
version = "0.1.0"
edition = "2021"
description = "Bevy's error codes"
publish = false
license = "MIT OR Apache-2.0"

[lints]
workspace = true

[dependencies]
bevy = { path = ".." }
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			`[package]`
			`name = "errors"`
			`version = "0.1.0"`
			`edition = "2021"`
Add readme to errors crate and clean up cargo files (#3125) # Objective - Document that the error codes will be rendered on the bevy website (see bevyengine/bevy-website#216) - Some Cargo.toml files did not include the license or a description field ## Solution - Readme for the errors crate - Mark internal/development crates with `publish = false` - Add missing license/descriptions to some crates - [x] merge bevyengine/bevy-website#216 2021-11-13 23:06:48 +00:00			`description = "Bevy's error codes"`
			`publish = false`
			`license = "MIT OR Apache-2.0"`
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
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 18:09:47 +01:00			`[lints]`
			`workspace = true`

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			`[dependencies]`
Add readme to errors crate and clean up cargo files (#3125) # Objective - Document that the error codes will be rendered on the bevy website (see bevyengine/bevy-website#216) - Some Cargo.toml files did not include the license or a description field ## Solution - Readme for the errors crate - Mark internal/development crates with `publish = false` - Add missing license/descriptions to some crates - [x] merge bevyengine/bevy-website#216 2021-11-13 23:06:48 +00:00			`bevy = { path = ".." }`