hedy icon indicating copy to clipboard operation
hedy copied to clipboard

💻 Rewrite first line of error messages

Open Felienne opened this issue 2 years ago • 3 comments

We have a project open for the phrasing of error messages (#3450) but I think there are a few other, smaller, things we can also do. I am interested in picking this up myself now that other stuff is working well.

I will open two issues today for discussion later on.

We need to critically assess the error message layout! Errors now always that with the same message in bold: image

This was really not a clear design decision. I think someone (maybe even me!) early on added this when we had 0 users and we never got back to it because there were so many other things to work on like teacher features.

Now that we have more time to think about this, I really believe we should remove this message, since:

  • it does not add information (is always the same)
  • it takes up space
  • it grabs the attention because it is bold

Any thought?

Felienne avatar Nov 09 '23 10:11 Felienne

I agree that the error message is not really helpful. I think that maybe we can the name of the error instead.

So in your example it'd be something like this:

image

jpelay avatar Nov 09 '23 14:11 jpelay

Here's the new design for the mistakes in the adventures! Image

gisellandrade avatar Jul 16 '24 01:07 gisellandrade

Here's the new design for the mistakes in the adventures! Image

I like it! If we want them to be unobtrusive and have a smaller footprint, this design does it. Although I think we could add a little more padding to it, so it's more prominent.

jpelay avatar Jul 16 '24 12:07 jpelay

These is the list of all the captions we use in the error messages:

  • Connection_error: We couldn't reach the server. => Happens when there's no connection to the server. Might be fused with the rest of the message: "We couldn't reach the server. Check whether your Internet connection is working."

  • Execute_error: Something went wrong while running the program. => might happen if the program failed, or it took too long, or skip faulty is enabled and we executed but notified the errors. Not sure how to fuse this with the rest of the error unless we do something like this, essentially merge together the messages. Still do it even if it's a python error (that aren't really all that helpful to show to kids, either):

image

  • Other_error: Oops! Maybe we made a little mistake. => This is the one where we ask people to send us they're program
  • Transpile_error: We can't run your program. => Possibly the one that offers the least ammount of info. Remove?
  • Transpile_warning: Warning! Also, remove?

@Felienne @AnneliesVlaar What do you guys think?

jpelay avatar Nov 08 '24 18:11 jpelay

These is the list of all the captions we use in the error messages:

  • Connection_error: We couldn't reach the server. => Happens when there's no connection to the server. Might be fused with the rest of the message: "We couldn't reach the server. Check whether your Internet connection is working."

I agree with fusing the caption with the message. If in the rare case that it is not about the internet connection but a problem with the server, this message shows that it can be problem on either of the two sides (our side or the side of the user).

  • Execute_error: Something went wrong while running the program. => might happen if the program failed, or it took too long, or skip faulty is enabled and we executed but notified the errors. Not sure how to fuse this with the rest of the error unless we do something like this, essentially merge together the messages. Still do it even if it's a python error (that aren't really all that helpful to show to kids, either):

image

I think this caption can also be removed. You would not get an error if there wasn't something wrong while running the program. The warning symbol and "your program takes too long to run" is enough information.

  • Other_error: Oops! Maybe we made a little mistake. => This is the one where we ask people to send us they're program

I like this caption because it shows that the blame is not always on the user.

  • Transpile_error: We can't run your program. => Possibly the one that offers the least ammount of info. Remove?

agree

  • Transpile_warning: Warning! Also, remove?

Is this about unused variables? "Warning!" can indeed be removed. In issue "add warnings about unused variables in list of variabels #5806 " I argue that we might want to show warnings not the same as errors.

@Felienne @AnneliesVlaar What do you guys think?

AnneliesVlaar avatar Nov 15 '24 10:11 AnneliesVlaar