Explain why each use of `unsafe` is sound
Open
documentation
enhancement
good first issue
P-medium
- Dominant language
- Rust
- Stars
- 4.8k
- Forks
- 565
- PR merge metrics
- No merged PRs in 30d
Description
See [that discussion on reddit](https://www.reddit.com/r/rust/comments/cm2858/about_the_future_of_nphysics_a_pure_rust_2d_and/ew0erxn/). Doing this will reassure others, that our unsafe code is actually sound.
We should add comments explaining why each `unsafe` is sound throughout the nalgebra source code.
Doing this will take an extremely large amount of time so any incremental contribution is welcome. In other words, event adding one comment for one `unsafe` statement is a great contribution and justify a PR.
All use of `mem::uninitialized` can be ignored and left uncommented as we intend to get rid of them. See #556.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.