Improve error dialogs #62

Closed
opened 2023-03-09 11:25:22 +01:00 by lucas · 1 comment
Owner

Fork color_eyre to expose more of its Handler's internal details, such as sections. Then I can use those to compose a custom representation of the error in the dialogs, rather than the default debug print.

Fork `color_eyre` to expose more of its `Handler`'s internal details, such as `sections`. Then I can use those to compose a custom representation of the error in the dialogs, rather than the default debug print.
lucas added the
crate/dtmm
kind
enhancement
stage
actionable
labels 2023-03-09 11:25:22 +01:00
lucas added this to the Mod Manager project 2023-03-09 11:25:22 +01:00
Author
Owner

While the full error chain is quite helpful to track an error in code, for user errors, only the root cause is generally helpful.

So the error dialogs should probably only display the top-most error, since that usually describes the operation that the user wanted to perform, and the bottom-most one, as that is where it actually failed.
For additional context, I might also want to provide the entry right above the root cause. E.g. when it's an IO error, I usually add the path as context above that.

Potential template:


Failed to deploy mods!

Failed to write deployment data to 'path/to/deployment': No such file or directory

Suggestion: Make sure the 'Game Directory' setting is correct.


While the full error chain is quite helpful to track an error in code, for user errors, only the root cause is generally helpful. So the error dialogs should probably only display the top-most error, since that usually describes the operation that the user wanted to perform, and the bottom-most one, as that is where it actually failed. For additional context, I might also want to provide the entry right above the root cause. E.g. when it's an IO error, I usually add the path as context above that. Potential template: --- #### Failed to deploy mods! Failed to write deployment data to 'path/to/deployment': No such file or directory **Suggestion:** Make sure the 'Game Directory' setting is correct. ---
lucas closed this issue 2023-03-28 20:50:16 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: bitsquid_dt/dtmt#62
No description provided.