Document all `unsafe` blocks.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
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.
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.
- Dominant language
- Rust
- Stars
- 2k
- Forks
- 254
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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/heapless
-
`FromIterator` for `Deque`Possibly taken @ollien claimed this 63 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
rust-embedded/heapless#683 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 45/100
rust-embedded/heapless#681 ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
rust-embedded/heapless#653 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 28/100
rust-embedded/heapless#645 · 5 comments · 1 reaction ·
-
Vec const-nessOpen
Difficulty 3/5 1-2 days Newbie friendliness 45/100
rust-embedded/heapless#643 · 3 comments ·
All issues in rust-embedded/heapless
Similar issues
-
[Bug] Completion info popup (.cm-completionInfo) ignores the configured editor fontPossibly taken A pull request linked to this issue is open or already merged. Openbug user-priority/P2
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
rescript-lang/rescript#8765 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
nautechsystems/nautilus_trader#5287 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
farion1231/cc-switch#8072 ·
Maintainers usually reply within 1 day
-
Python 3.15 supportPossibly taken @amnesiaof claimed this today. OpenL: python L: python:uv
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
dependabot/dependabot-core#16524 · 1 comment ·
Maintainers usually reply within 1 day