bevy/errors/Cargo.toml

[package]
name = "errors"
edition = "2021"
description = "Documentation and tests for Bevy's error codes"
publish = false
license = "MIT OR Apache-2.0"

[dependencies]
bevy = { path = ".." }

[lints]
workspace = true

[package.metadata.docs.rs]
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
all-features = 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			`[package]`
			`name = "errors"`
			`edition = "2021"`
Remove `version` field for non-publish crates and update descriptions (#13100) # Objective - The [`version`] field in `Cargo.toml` is optional for crates not published on <https://crates.io>. - We have several `publish = false` tools in this repository that still have a version field, even when it's not useful. [`version`]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field ## Solution - Remove the [`version`] field for all crates where `publish = false`. - Update the description on a few crates and remove extra newlines as well. 2024-04-26 11:55:03 +00:00			`description = "Documentation and tests for Bevy's error codes"`
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			`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
			`[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 = ".." }`
Make `feature(doc_auto_cfg)` work (#12642) # Objective - In #12366 `![cfg_attr(docsrs, feature(doc_auto_cfg))] `was added. But to apply it it needs `--cfg=docsrs` in rustdoc-args. ## Solution - Apply `--cfg=docsrs` to all crates and CI. I also added `[package.metadata.docs.rs]` to all crates to avoid adding code behind a feature and forget adding the metadata. Before: ![Screenshot 2024-03-22 at 00 51 57](https://github.com/bevyengine/bevy/assets/104745335/6a9dfdaa-8710-4784-852b-5f9b74e3522c) After: ![Screenshot 2024-03-22 at 00 51 32](https://github.com/bevyengine/bevy/assets/104745335/c5bd6d8e-8ddb-45b3-b844-5ecf9f88961c) 2024-03-23 02:22:52 +00:00
			`[lints]`
			`workspace = true`

			`[package.metadata.docs.rs]`
			`rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]`
			`all-features = true`