mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 14:40:19 +00:00
1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
32 lines
1.3 KiB
Rust
32 lines
1.3 KiB
Rust
//! This example illustrates how to use logs in bevy.
|
|
|
|
use bevy::prelude::*;
|
|
|
|
fn main() {
|
|
App::new()
|
|
// Uncomment this to override the default log settings:
|
|
// .insert_resource(bevy::log::LogSettings {
|
|
// level: bevy::log::Level::TRACE,
|
|
// filter: "wgpu=warn,bevy_ecs=info".to_string(),
|
|
// })
|
|
.add_plugins(DefaultPlugins)
|
|
.add_system(log_system)
|
|
.run();
|
|
}
|
|
|
|
fn log_system() {
|
|
// here is how you write new logs at each "log level" (in "least important" to "most important"
|
|
// order)
|
|
trace!("very noisy");
|
|
debug!("helpful for debugging");
|
|
info!("helpful information that is worth printing by default");
|
|
warn!("something bad happened that isn't a failure, but thats worth calling out");
|
|
error!("something failed");
|
|
|
|
// by default, trace and debug logs are ignored because they are "noisy"
|
|
// you can control what level is logged by adding the LogSettings resource
|
|
// alternatively you can set the log level via the RUST_LOG=LEVEL environment variable
|
|
// ex: RUST_LOG=trace, RUST_LOG=info,bevy_ecs=warn
|
|
// the format used here is super flexible. check out this documentation for more info:
|
|
// https://docs.rs/tracing-subscriber/*/tracing_subscriber/filter/struct.EnvFilter.html
|
|
}
|