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

No documentation about exceptions #79

Open
Kaldesyvon opened this issue Apr 24, 2024 · 1 comment
Open

No documentation about exceptions #79

Kaldesyvon opened this issue Apr 24, 2024 · 1 comment
Assignees

Comments

@Kaldesyvon
Copy link

There is zero information about exception that methods can throw. User can be confused and get convinced that no method throws exception. On the other hand user can suppose that methods such as Query() and Insert() could throw exceptions (bad connection, bad credentials, ...) and do not get his information about that.

I think that exceptions should be mentioned in docs.

@JonathanMagnan JonathanMagnan self-assigned this Apr 24, 2024
@JonathanMagnan
Copy link
Member

Hello @Kaldesyvon ,

Thank you for your recommendation. I will note this when I re-write some parts of our documentation.

Indeed, having a page that describes multiple common exceptions could be very helpful.

Best Regards,

Jon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants