jamesjuett / lobster

Interactive Program Visualization Tools
8 stars 3 forks source link

Fix #299 #303

Open shleen opened 2 years ago

shleen commented 2 years ago

Super easy fix for #299 .

Just added css to make sure too-long error identifiers are being broken in the compilation notes pane.

Screenshot 2022-02-28 at 6 51 43 PM
jamesjuett commented 2 years ago

After a bit more reflection, I wonder if a better fix might be to hide the actual error ID behind an icon that has a tooltip on hover or something like that? Students don't really need to see the error ID.

shleen commented 2 years ago

Hm yeah I see your point there, but I feel like hiding the error ID lets students think that compiler errors will always be super readable & tell them exactly what is wrong, which isn't really accurate. What do you think? I'm happy to hide the ID behind a tooltip though if you feel like that makes more sense with what lobster is trying to be.

jamesjuett commented 2 years ago

Fair point about compiler messages - one thing that I've considered in the past is an overhaul of the error messages Lobster gives to students (you can see them all in errors.ts) to target some specific learning objectives. There's some interesting research out there (though not terribly comprehensive) on how improved compiler errors may help students. For Lobster, I think it would be kind of cool to have a couple different kinds of messages, maybe with one version that is sort of like what a normal compiler would give you, one that is more student-focused, and perhaps even links to examples or more in-depth explanations for errors we know students are likely to run into.

But - for this issue and for now, I think it makes sense to just make the UI nicer, so I think something like hiding them behind a tooltip makes sense. The error IDs are not always terribly intuitive and are probably most useful for uniquely identifying which error is being given for something like bug reporting.

shleen commented 2 years ago

Okay yeah, that makes sense. I'll make the change!