rust-embedded / discovery

Discover the world of microcontrollers through Rust!
https://docs.rust-embedded.org/discovery/
Apache License 2.0
1.47k stars 510 forks source link

Unclear sentence in 06-hello-world #485

Open ConnorMooneyhan opened 1 year ago

ConnorMooneyhan commented 1 year ago

The following sentence in chapter 6 just doesn't really make sense:

Also, it setup break points and stepped through the trampoline we are at the first executable statement in fn main().

I'm not quite sure what a better wording would be because I can't tell exactly what the author is trying to say, but perhaps it's something like this:

It also set up breakpoints and stepped through the trampoline, so now we are at the first executable statement in fn main().

I think it's important to include a link with the word "trampoline" since it's the first time that word is used in this text and it's likely to be new to the reader; it certainly was to me. The Wikipedia page was sparse and high-level, so I chose to link to a StackOverflow answer in my suggestion, but another explanation could be chosen. Even better, if "trampoline" is an important concept, it could be explained in the book itself so as to be more self-contained.

I can PR this at some point but I feel like it's worth thinking through my suggested update first to clarify the desired approach.

eldruin commented 1 year ago

Sounds like a good improvement! I would certainly welcome this as a PR

Jzow commented 1 year ago

I also think there is a should better explanation for the "trampoline"