Adding a small explanations on hardware exceptions vs software exceptions
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation, embedded-iot
Research direction
Open the exceptions chapter at the linked URL and locate the first paragraph under the hardware exceptions section. Add the proposed explanation directly after it, preserving the Rust and Result links, and verify that the rendered text clearly distinguishes hardware exceptions from software error handling.
Written by the indexing model from the issue text.
Description
In the book there is a paragraph on hardware exceptions:
https://docs.rust-embedded.org/book/start/exceptions.html?highlight=exception#the-default-exception-handler
This can be a question mark for people used to software exceptions.
What about adding, directly after the first paragraph:
Hardware exceptions are different from exceptions thrown in software, which are a way of handling errors for both recoverable and unrecoverable errors. For recoverable error handling, Rust uses the Result type Result<T, E>, where T is the Ok value type, and E is a specific, configurable error. For unrecoverable software error handling, Rust uses panic that stops execution. This is closer to exceptions thrown in software using other languages.
If you think it can be a useful addition I can make a PR.
- Dominant language
- No language data
- Stars
- 1.3k
- Forks
- 223
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-embedded/book
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
rust-embedded/book#414 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
rust-embedded/book#370 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
rust-embedded/book#345 · 2 reactions ·
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
rust-embedded/book#208 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
rust-embedded/book#147 ·
All issues in rust-embedded/book
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·