rust-embedded / rust-embedded/heapless
Document all `unsafe` blocks.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2k
- Forks
- 253
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
All unsafe blocks should be documented with a SAFETY comment and be scoped as closely as possible.
After all are documented, the clippy::undocumented_unsafe_blocks lint should be enabled.
Also, the unsafe_op_in_unsafe_fn lint should be enabled (default in edition 2024), so that unsafe blocks in unsafe functions are also documented.
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
Search the repository for every unsafe block and review the Rust lint configuration. Add a SAFETY comment to each block, scope unsafe operations closely, and enable clippy::undocumented_unsafe_blocks and unsafe_op_in_unsafe_fn; done means the lints pass across the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100