feat: improve uninformative error messages #10201
Open
Conversation
This file contains 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
GarmashAlex
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
mattsse
reviewed
Mar 29, 2025
crates/chisel/src/dispatcher.rs
Outdated
| @@ -258,7 +258,7 @@ impl ChiselDispatcher { | |||
| self.session.id.as_ref().unwrap() | |||
| ))) | |||
| } else { | |||
| DispatchResult::CommandFailed(Self::make_error("Too many arguments supplied!")) | |||
| DispatchResult::CommandFailed(Self::make_error("Too many arguments supplied! Please check command syntax.")) | |||
There was a problem hiding this comment.
I think here it would be better to include all the arguments so the user can easily double check it
There was a problem hiding this comment.
@mattsse Corrected. Thank you for looking this through
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Motivation
Error messages in Chisel's dispatcher were uninformative in some cases, making it difficult for users to understand what went wrong and how to fix the issue. Simple messages like "Failed to load session!" or "Invalid fork URL!" didn't provide enough context for users to troubleshoot effectively.
Solution
Improved several error messages in the Chisel dispatcher by adding more context and guidance to make them more helpful and actionable. The changes maintain the existing code logic and message format while providing clearer details about what went wrong and potential fixes.
For example:
These enhanced error messages will help users understand issues more quickly without having to dig through the code.
PR Checklist