Skip to content

add section when to return result#13635

Open
ShahakShama wants to merge 1 commit intoshahak/style-guide-error-suffixfrom
shahak/style-guide-when-to-return-result
Open

add section when to return result#13635
ShahakShama wants to merge 1 commit intoshahak/style-guide-error-suffixfrom
shahak/style-guide-when-to-return-result

Conversation

@ShahakShama
Copy link
Copy Markdown
Collaborator

@ShahakShama ShahakShama commented Mar 31, 2026

Note

Low Risk
Low risk documentation-only change that doesn’t affect runtime behavior. Minor risk of shifting team conventions around error propagation/panics.

Overview
Adds a new “When to return Result section to style.md, advising to return Result only for errors callers are expected to handle.

Recommends panicking at the source when failure should abort, and handling/logging internally when errors are intentionally ignored, rather than forcing callers to discard results.

Written by Cursor Bugbot for commit 0e7c9a6. This will update automatically on new commits. Configure here.

@ShahakShama ShahakShama requested a review from Stavbe March 31, 2026 16:19
@reviewable-StarkWare
Copy link
Copy Markdown

This change is Reviewable

Copy link
Copy Markdown
Collaborator Author

ShahakShama commented Mar 31, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

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