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

Organize error messages better #97

Open
cjmyers opened this issue Jun 8, 2018 · 3 comments
Open

Organize error messages better #97

cjmyers opened this issue Jun 8, 2018 · 3 comments

Comments

@cjmyers
Copy link
Contributor

cjmyers commented Jun 8, 2018

Make it very clear in the validator when an error is a error (serious problem, red checkbox in the list), a completeness issue (blue circle, can be ignored, if you like by turning off completeness checking), or a best practice (this is off by default actually).

Maybe an output like:

We found W validation errors in your file, click here for more details.
These are serious errors with your SBOL file that cannot be ignored.

We found X completeness warnings in your file, click here for more details.
If you wish to ignore these in the future, select Allow incomplete documents.

We found Y URI compliance warnings in your file, click here for more details.
If you wish to ignore these in the future, select Allow non-compliant URIs.

We found Z best practice warnings in your file, click here for more details.
If you wish to ignore these in the future, de-select Check best practices.

@cjmyers cjmyers added this to the 1.3 milestone Jun 8, 2018
@cjmyers
Copy link
Contributor Author

cjmyers commented Jun 8, 2018

Add this text to that above:

"These errors are typically due to a problem with the software that generated this SBOL file. Therefore, you should report these errors to the developers of that software package."

Longer term, would be cool to have an email address field that the user could fill to automatically forward the errors to the developers along with the example file.

@3ach
Copy link
Collaborator

3ach commented Jun 27, 2018

I'm happy to do this, but is there any way we could add better error passing to libSBOLj, specifcally some kind of structured output I don't have to build a parser for?
JSON would work well, and there's lot of existing infrastructure in Java and Python (the backend language of the validator.) If not, even null-byte-terminated messages would help. I just think hand-written deserialization code is going to be a beast to maintain.

@cjmyers
Copy link
Contributor Author

cjmyers commented Jun 27, 2018

Yes, let's do this. We can work out format when we meet Thursday.

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

No branches or pull requests

2 participants