-
Notifications
You must be signed in to change notification settings - Fork 841
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add guidelines for choosing panics or error results #6958
Conversation
I wonder if there is some way to work this comment into this #6737 (comment) I think it articulates something very important, that simply blindly changing panics to results is not desirable |
Thanks for the comment! Added a note to emphasize that it's about reporting invalidity of user input as error results which does not necessarily replaces panic/assert for sanity checks, PTAL! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Andrew Lamb <[email protected]>
Thanks for the reviews! Updated as suggested, PTAL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me -- thanks again @jp0317
* add guidelines for choosing panics or error results * add note to clarify that checking invalidity of user input is the key point * apply reviewer suggestions Co-authored-by: Andrew Lamb <[email protected]> * remove redundant word * fix markdown format --------- Co-authored-by: jp0317 <[email protected]> Co-authored-by: Andrew Lamb <[email protected]>
Which issue does this PR close?
Closes #6737
Rationale for this change
Add guidelines as per discussed in #6737
What changes are included in this PR?
guidelines
Are there any user-facing changes?
n/a