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

Enhance error handling: implement user-friendly error messages for common issues #386

Closed
3 tasks
albertpod opened this issue Dec 12, 2024 · 1 comment
Closed
3 tasks
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@albertpod
Copy link
Member

Julia's stacktraces are often difficult to parse, leading to user frustration when debugging RxInfer.

Proposal

Following on @fonsp suggestion, we should create a system to catch common errors and display helpful messages like:

We noticed you encountered an error that typically occurs when [specific condition].
Don't worry - this is a common issue that can be resolved!
📚 First, check our documentation at:
`https://reactivebayes.github.io/RxInfer.jl/stable/`
💬 If you can't find what you need, please open a discussion at:
`https://github.com/orgs/ReactiveBayes/discussions`
We're here to help make your experience with RxInfer better!

Implementation

  • Identify and catch common error patterns
  • Replace stacktraces with friendly messages
  • Direct users to documentation and discussions
@albertpod albertpod added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 12, 2024
@bvdmitri
Copy link
Member

Fixed in #391

@github-project-automation github-project-automation bot moved this to ✅ Done in RxInfer Dec 23, 2024
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 enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants