Skip to content

Add FAQ about miri test failures#21

Merged
SF-Zhou merged 2 commits intomainfrom
SF-Zhou-patch-1
Dec 27, 2025
Merged

Add FAQ about miri test failures#21
SF-Zhou merged 2 commits intomainfrom
SF-Zhou-patch-1

Conversation

@SF-Zhou
Copy link
Owner

@SF-Zhou SF-Zhou commented Dec 27, 2025

Added FAQ section explaining the expected failure of miri tests due to Stacked Borrows violation and provided details on the safety of the implementation.

Added FAQ section explaining the expected failure of miri tests due to Stacked Borrows violation and provided details on the safety of the implementation.
Copilot AI review requested due to automatic review settings December 27, 2025 16:30
@codecov
Copy link

codecov bot commented Dec 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (b2169a9) to head (0d9352a).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@SF-Zhou SF-Zhou merged commit 6c1fa5f into main Dec 27, 2025
6 checks passed
@SF-Zhou SF-Zhou deleted the SF-Zhou-patch-1 branch December 27, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants