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

Create a convention for how we report errors. #243

Open
bshifaw opened this issue Feb 8, 2023 · 0 comments
Open

Create a convention for how we report errors. #243

bshifaw opened this issue Feb 8, 2023 · 0 comments
Labels
Cromshell 2 Issues related to Cromshell 2.0

Comments

@bshifaw
Copy link
Collaborator

bshifaw commented Feb 8, 2023

This is a bigger issue than this PR, but we need to come up with a convention for how we report errors. I think that we have to choose something and try to be consistent in all of our tools. We currently have a mix of log and quit, log and print, log and throw, just throw, and probably just log. It's confusing.

I'm a big fan of the GATK distinction between UserException and GATKException. UserExceptions are error conditions that are probably the fault of the user, like accessing still running workflow or having a full disk. GATKExceptions are cases we thought about which might happen if there is a bug somewhere else generally. And then there are just the native exceptions thrown by the code we call.

I think we should consider something similar. (*not necessarily in this pr)

Originally posted by @lbergelson in #240 (comment)

@bshifaw bshifaw added the Cromshell 2 Issues related to Cromshell 2.0 label Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cromshell 2 Issues related to Cromshell 2.0
Projects
None yet
Development

No branches or pull requests

1 participant