allow unreachable, and expand when to use panic#13636
Open
ShahakShama wants to merge 1 commit intoshahak/style-guide-when-to-return-resultfrom
Open
allow unreachable, and expand when to use panic#13636ShahakShama wants to merge 1 commit intoshahak/style-guide-when-to-return-resultfrom
ShahakShama wants to merge 1 commit intoshahak/style-guide-when-to-return-resultfrom
Conversation
This was referenced Mar 31, 2026
Collaborator
Author
This was referenced Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Note
Low Risk
Low risk: documentation-only changes with no runtime or API impact. Main risk is behavioral inconsistency if teams interpret the new
panic!/unreachable!guidance differently.Overview
Clarifies the error-handling conventions in
style.mdby expanding whenpanic!is appropriate (unrecoverable states vs. bugs) and explicitly allowingunreachable!for provably unreachable code paths while discouragingunimplemented!.Renames and broadens the messaging guideline section to cover
unreachable!(and invariant-styleexpect) messages, emphasizing documenting why a failure is impossible rather than restating the error.Written by Cursor Bugbot for commit 1cfd5b0. This will update automatically on new commits. Configure here.