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

Misleading error reporting in HTML repr #225

Closed
jl-wynen opened this issue Aug 26, 2024 · 0 comments · Fixed by #229
Closed

Misleading error reporting in HTML repr #225

jl-wynen opened this issue Aug 26, 2024 · 0 comments · Fixed by #229
Labels
bug Something isn't working

Comments

@jl-wynen
Copy link
Collaborator

jl-wynen commented Aug 26, 2024

When showing, e.g., a raw dataset, the HTML repr marks usedSoftware and inputDatasets as required and missing.

I misread the repr. The shown fields are marked with an asterisk because they are required by derived datasets. But they are only shown in the first place because they are set to not-None. So there are two issues here:

I am unsure how to show the error type nicely.

  • Tooltips don't seem to work well in Jupyter.
  • There is no space to add an explanation. We could co-opt the 'Description' column and use a different font / colour to distinguish errors from regular descriptions. But that would hide the description.
  • We could also use icons. But they would need a legend.
  • We could add a new section of error messages at the bottom.

At least, we can omit the asterisk from fields that are not allowed to be used for a given dataset type.

See also #77

@jl-wynen jl-wynen added the bug Something isn't working label Aug 26, 2024
@jl-wynen jl-wynen changed the title HTML repr shows fields of other dataset type as required Misleading error reporting in HTML repr Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant