Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error handling guide #376

Open
ealmloff opened this issue Jan 7, 2025 · 0 comments
Open

Improve error handling guide #376

ealmloff opened this issue Jan 7, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ealmloff
Copy link
Member

ealmloff commented Jan 7, 2025

Error Handling Guide

The error handling guide was partially updated for 0.6, but some sections still reference Option<VNode>. We need to update the guide and potentially move it to the essentials section. There are also a few improvements we can make to the error handling guide:

  • The first two sections return errors with ? without introducing the error type
  • Throwing an error from event handlers is not mentioned in the guide
  • Error handling in the result of resources isn't mentioned in the guide, but can be difficult when the error type is not clone (like reqwest::Error)
  • The guide should talk about the context and show methods on the Context trait
@ealmloff ealmloff added the documentation Improvements or additions to documentation label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant