Clarification needed in unwinding section
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 2.3k
- Forks
- 325
- PR merge metrics
- No merged PRs in 30d
Description
Don't build your programs to unwind under normal circumstances.
It isn't clear what "build your programs to unwind" means. Is this suggesting one should normally not use catch_unwind or that panic='abort' should be used?
Also, it would be helpful to see some examples of abnormal circumstances where unwinding is appropriate.
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.
Research direction
Start at the unwinding section containing the quoted guidance and review how it relates to catch_unwind and panic='abort'. Clarify what “build your programs to unwind” means and add examples of abnormal circumstances where unwinding is appropriate, so the section answers both questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100