Enhance SDK Error Handling and Naming for Improved Clarity #3

New Issue

fenpaws · 2024-02-07T11:23:35Z

fenpaws commented

2024-02-07 11:23:35 +00:00

I encountered an issue where the plugin returned a not found error. It wasn't immediately clear that the error was thrown by the SDK, which led to some confusion during troubleshooting.

To improve user experience and ease of debugging, I propose enhancing our error handling and naming within the SDK. This could potentially involve introducing two sets of errors:

Low-Level Errors: These would be the technical, system-level errors we currently have. They are useful for developers who are familiar with the underlying system and can understand the technical details.
High-Level Errors: These would provide a more descriptive and user-friendly explanation of what went wrong. They could help users who are not as familiar with the system internals, by describing the error in a more understandable way.

This dual approach could help both experienced and novice users of our SDK, by providing the right level of detail based on their needs and familiarity with the system. It would also help to pinpoint the source of the error more quickly, thereby reducing debugging time.

I encountered an issue where the plugin returned a `not found` error. It wasn't immediately clear that the error was thrown by the SDK, which led to some confusion during troubleshooting. To improve user experience and ease of debugging, I propose enhancing our error handling and naming within the SDK. This could potentially involve introducing two sets of errors: 1. **Low-Level Errors**: These would be the technical, system-level errors we currently have. They are useful for developers who are familiar with the underlying system and can understand the technical details. 2. **High-Level Errors**: These would provide a more descriptive and user-friendly explanation of what went wrong. They could help users who are not as familiar with the system internals, by describing the error in a more understandable way. This dual approach could help both experienced and novice users of our SDK, by providing the right level of detail based on their needs and familiarity with the system. It would also help to pinpoint the source of the error more quickly, thereby reducing debugging time.

fenpaws added the

enhancement

help wanted

labels 2024-02-07 11:23:35 +00:00

This repo is archived. You cannot comment on issues.