Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - add documentation on LogPlugin and more log usage #1973

Closed
wants to merge 4 commits into from

Conversation

mockersf
Copy link
Member

Fixes #1895

Changed most println to info in examples, some to warn when it was useful to differentiate from other more noisy logs.

Added doc on LogPlugin, how to configure it, and why (and how) you may need to disable it

@alice-i-cecile alice-i-cecile added C-Code-Quality A section of code that is hard to understand or change A-Core Common functionality for all bevy apps C-Docs An addition or correction to our documentation labels Apr 21, 2021
crates/bevy_log/src/lib.rs Outdated Show resolved Hide resolved
examples/2d/many_sprites.rs Outdated Show resolved Hide resolved
} else {
println!("sphere hasn't loaded yet");
info!("sphere hasn't loaded yet");
Copy link

@ghost ghost Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nitpicking but there is some inconsistency in examples now whether capitalization is used at the start for the log messages.

E.g.

"sphere hasn't loaded yet"

vs.

""Custom asset loaded: {:?}"

in custom_asset.rs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think starting with a capital is the right call. Feel free to follow up with another pr that makes this consistent if you feel inclined :)

@cart
Copy link
Member

cart commented Apr 22, 2021

bors r+

bors bot pushed a commit that referenced this pull request Apr 22, 2021
Fixes #1895 

Changed most `println` to `info` in examples, some to `warn` when it was useful to differentiate from other more noisy logs.

Added doc on `LogPlugin`, how to configure it, and why (and how) you may need to disable it
@bors bors bot changed the title add documentation on LogPlugin and more log usage [Merged by Bors] - add documentation on LogPlugin and more log usage Apr 22, 2021
@bors bors bot closed this Apr 22, 2021
ostwilkens pushed a commit to ostwilkens/bevy that referenced this pull request Jul 27, 2021
Fixes bevyengine#1895 

Changed most `println` to `info` in examples, some to `warn` when it was useful to differentiate from other more noisy logs.

Added doc on `LogPlugin`, how to configure it, and why (and how) you may need to disable it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Core Common functionality for all bevy apps C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

promote usage of logs rather than printing to stdout
3 participants