add guidelines for choosing panics or error results#6958
Merged
Conversation
Contributor
|
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 |
Contributor
Author
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! |
alamb
approved these changes
Jan 10, 2025
Closed
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Contributor
Author
|
Thanks for the reviews! Updated as suggested, PTAL. |
svencowart
pushed a commit
to elastiflow/arrow-rs
that referenced
this pull request
Jan 14, 2025
* 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 <andrew@nerdnetworks.org> * remove redundant word * fix markdown format --------- Co-authored-by: jp0317 <zjpzlz@gmail.com> Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
totoroyyb
pushed a commit
to totoroyyb/arrow-rs
that referenced
this pull request
Jan 20, 2025
* 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 <andrew@nerdnetworks.org> * remove redundant word * fix markdown format --------- Co-authored-by: jp0317 <zjpzlz@gmail.com> Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
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.
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