hsivonen / hsivonen/encoding_rs
Unsafe review notes
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 464
- Forks
- 70
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 2
Description
I'm performing an unsafe review of encoding_rs. The hope is by the end of this I will have safety documentation for all unsafe blocks in the crate.
Opening this issue to keep track of things I have found, especially things I do not plan to fix with documentation (but may fix later).
The branch with the documentation is https://github.com/manishearth/encoding_rs/tree/unsafe (compare)
Contributor guide
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 by reviewing the unsafe branch and the unsafe blocks in the encoding_rs crate. Compare its documentation changes with the issue’s goal of covering all unsafe blocks, and review the notes for items not planned for documentation. Done means the remaining applicable unsafe blocks have safety documentation or are explicitly tracked for later work.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100