Conversation
Added FAQ section explaining the expected failure of miri tests due to Stacked Borrows violation and provided details on the safety of the implementation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #21 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 870 870
=========================================
Hits 870 870 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull request overview
This PR adds a FAQ section to the README explaining why miri tests fail for this crate. The documentation clarifies that the Stacked Borrows violation is expected and intentional due to the crate's use of raw pointers with moved Box values, and provides justification for why this pattern is safe in practice.
- Added FAQ section with explanation of miri test failures
- Included code example demonstrating the pattern causing the violation
- Provided safety rationale and reference to detailed issue discussion
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Added FAQ section explaining the expected failure of miri tests due to Stacked Borrows violation and provided details on the safety of the implementation.