bevyengine / bevyengine/bevy-website

Use info! instead of println! in tutorial

Open
#108 2 comments 0 reactions 0 assignees View on GitHub
A-Book C-Content D-Trivial S-Blocked
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

When debugging actual Bevy games, you almost always want to use `info!` instead of `println` in order to reduce blocking behavior.

This is not at all obvious to Rust beginners, and showing them how to use `println` misleads them into thinking it's a good pattern to replicate.

This was a simple find-and-replace change for me, and resulted in much faster looping.

Contributor guide

Open the contributing guide

Research direction

Search the tutorial content for uses of Rust's println! macro; the issue does not name a specific file or test. Replace the tutorial's debugging examples with info! where appropriate, then verify the examples still build and teach the intended logging pattern.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.