Improve error message language and polishing · Pull Request #5635 · hedyorg/hedy

ghost · 2024-06-27T14:50:07Z

This pull request is part of a larger project in which we are redesigning our error messages according to these guidelines.

In this PR, I have worked on the redesigning topic (v) Langauge. I removed words like cannot, illegal, invalid etc. to not blame the user and make the sentence more positive. Also worked on polishing some of the error messages according to the given feedback and tried to find anything inconsistent that got missed.

Addresses #5012

FKEFFIEENFIENFFI

I tried to shorten them by using the requirements of Clarity and brevity requirements which are (aesthetic and minimalist design, recognition rather than recall). Meaning the errors should be shortened because students tend to not read the whole error so it should give out the critical info at the first part, that way a student can understand what it is going to say by not fully reading the whole sentence.

Some suggestions on the first 7 error messages according to the given feedback

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

…nto Artun-test-branch

Felienne · 2024-06-28T08:22:14Z

translations/en/LC_MESSAGES/messages.po


 msgid "Incomplete Repeat"
-msgstr "We detected that the `{repeat}` on line {line_number} is missing a `{command}` command. Can you try adding it?"
+msgstr "We detected that the `{repeat}` seems to be missing a `{command}` command, on line {line_number}. Can you try adding `{repeat}` with `{command}`?"


The 'seems to be' part is a bit long and doen not add something perse. We could make it shorter without losing info?

I have made a suggestion, also moving the line number into the sentence, which I find reads nicer? If you want to move it back, feel free to do so!

Felienne · 2024-06-28T08:22:48Z

translations/en/LC_MESSAGES/messages.po


 msgid "Incomplete Repeat"
-msgstr "We detected that the `{repeat}` on line {line_number} is missing a `{command}` command. Can you try adding it?"
+msgstr "We detected that the `{repeat}` seems to be missing a `{command}` command, on line {line_number}. Can you try adding `{repeat}` with `{command}`?"


Suggested change

msgstr "We detected that the `{repeat}` seems to be missing a `{command}` command, on line {line_number}. Can you try adding `{repeat}` with `{command}`?"

msgstr "We detected that the `{repeat}` on line {line_number} is missing a `{command}` command. Can you try adding `{repeat}` with `{command}`?"

Felienne · 2024-06-28T08:24:01Z

translations/en/LC_MESSAGES/messages.po


 msgid "Invalid Argument"
-msgstr "We detected that `{command}` is not usable with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"
+msgstr "We detected that `{command}` may not be used with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"


Suggested change

msgstr "We detected that `{command}` may not be used with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"

msgstr "We detected a `{command}` that can't be used with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"

Felienne

Thanks @ArtV11!

This is surely going the right way. I made a number of suggestions

Felienne · 2024-06-28T08:31:10Z

translations/en/LC_MESSAGES/messages.po


 msgid "Invalid Argument Type"
-msgstr "We detected that `{command}` doesn't work with `{invalid_argument}` because it is {invalid_type}. Can you try changing `{invalid_argument}` to {allowed_types}?"
+msgstr "We detected that `{command}` may not be used with `{invalid_argument}` because it is {invalid_type}. Can you try changing `{invalid_argument}` to {allowed_types}?"


The may phrasing is a bit weird. I think we should rephrase (see above)

Felienne · 2024-06-28T08:31:25Z

translations/en/LC_MESSAGES/messages.po


 msgid "Invalid At Command"
-msgstr "We detected that `{command}` may not be used from level 16 onward. Can you try using square brackets `[]` for lists?"
+msgstr "We detected that `{command}` may not be used from level 16 onward. Can you try adding square brackets around `[]` the list?\""


is the " needed?

Felienne · 2024-06-28T08:31:52Z

translations/en/LC_MESSAGES/messages.po


 msgid "Invalid Space"
-msgstr "We detected that line {line_number} started with a space. Can you try removing the space?"
+msgstr "We detected that line {line_number} started with a space. Can you remove the space?"


Here we are removing try, which is think is good, but it still is there in other places.

Felienne · 2024-06-28T08:32:19Z

translations/en/LC_MESSAGES/messages.po


 msgid "Invalid Type Combination"
-msgstr "We detected that `{invalid_argument}` and `{invalid_argument_2}` cannot be used with `{command}` because one is {invalid_type} and the other is {invalid_type_2}. Can you try changing `{invalid_argument}` to {invalid_type_2} or `{invalid_argument_2}` to {invalid_type}?"
+msgstr "We detected that `{invalid_argument}` and `{invalid_argument_2}` may not be used with `{command}` because one is {invalid_type} and the other is {invalid_type_2}. Can you try changing `{invalid_argument}` to {invalid_type_2} or `{invalid_argument_2}` to {invalid_type}?"


may does not mean what you think is means. Can't is fine as it is!

Felienne · 2024-06-28T08:32:31Z

translations/en/LC_MESSAGES/messages.po


 msgid "Misspelled At Command"
-msgstr "We detected that `{invalid_argument}` seems to have a spelling mistake on line {line_number}. Can you try writing `{command}` instead."
+msgstr "We detected that `{invalid_argument}` seems to have a spelling error on line {line_number}. Can you try writing `{command}` instead."


is error better than mistake? Why?

Felienne · 2024-06-28T08:32:45Z

translations/en/LC_MESSAGES/messages.po


 msgid "Pressit Missing Else"
-msgstr "We detected that the code is missing an `{else}` to handle other key presses. Can you try adding an `{else}` to your code?"
+msgstr "We detected that the code seems to be missing an `{else}` to handle other key presses. Can you try adding an `{else}` to your code?"


is is more concise then seems to?

Felienne · 2024-06-28T08:33:16Z

translations/en/LC_MESSAGES/messages.po


 msgid "Parse"
-msgstr "We detected that `{character_found}` is being used on line {location[0]} which is not allowed. Can you try looking for a missing or an extra character on your code?"
+msgstr "We detected that `{character_found}` is being used on line {location[0]} which is not possible. Can you try looking for a missing or an extra character on your code?"


well it is possible, because the kid did it :)

Maybe we can say: which hedy can't process or something like that?

jpelay · 2024-06-28T14:16:26Z

This is surely going the right way. I made a number of suggestions

I also like the way we are working on the error messages!

jpelay · 2024-11-27T22:18:02Z

I changed the behavior of the profile settings page. Now even if you force the language to change by changing the subdomain, iof you enter in the profile settings page it will still show your prefered language

Felienne · 2024-11-28T06:07:46Z

I changed the behavior of the profile settings page. Now even if you force the language to change by changing the subdomain, iof you enter in the profile settings page it will still show your prefered language

Is this related to the error messages PR?

jpelay · 2024-11-28T13:03:55Z

I changed the behavior of the profile settings page. Now even if you force the language to change by changing the subdomain, iof you enter in the profile settings page it will still show your prefered language

Is this related to the error messages PR?

To the subdomains one 😭 having several github tabs bit me.

Rtune11 and others added 30 commits May 21, 2024 15:15

Draft Errors

04637cc

FKEFFIEENFIENFFI

🤖 Automatically update generated files

22e0104

Merge branch 'main' into Artun-test-branch

b52e02d

Structure and consistency

4e4750d

Merge branch 'main' into Artun-test-branch

111c477

Alternative messages

b5aec3f

Some suggestions on the first 7 error messages according to the given feedback

🤖 Automatically update generated files

a0c08c7

Merge branch 'main' into Artun-test-branch

491f8e0

Alternative message structure applied to each error message

a41835e

🤖 Automatically update generated files

b08ab5e

Merge branch 'main' into Artun-test-branch

cceef39

Merge branch 'main' into Artun-test-branch

a630e0e

fix empty msgstr

5c9d0c7

fix cypress tests

655b9b8

Removed complex words

bd17dd1

Update messages.po

c9b33d7

Updated messages and the test

7f0cb83

Update invalid_program.cy.js

d74ea07

Update translations/en/LC_MESSAGES/messages.po

be80e05

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

Update translations/en/LC_MESSAGES/messages.po

855fb57

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

Update translations/en/LC_MESSAGES/messages.po

c7b4fa8

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

Update translations/en/LC_MESSAGES/messages.po

48c747d

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

Update translations/en/LC_MESSAGES/messages.po

790a9e9

Co-authored-by: Jesús Pelay <45865185+jpelay@users.noreply.github.com>

Merge branch 'main' into Artun-test-branch

9271bfe

Merge branch 'main' into Artun-test-branch

6fa1f8c

Cypress test fix next to language and consistency

b49a78a

🤖 Automatically update generated files

cca8d57

Update invalid_program.cy.js

ca2da41

Merge branch 'Artun-test-branch' of https://github.com/hedyorg/hedy i…

afc55da

…nto Artun-test-branch

Felienne reviewed Jun 28, 2024

View reviewed changes

Felienne requested changes Jun 28, 2024

View reviewed changes

Rtune11 added 2 commits July 1, 2024 08:34

Applying the suggestions

dd83072

Merge branch 'main' into Artun-test-branch

bbfa3bb

jpelay added content issues related to adventure tabs error messages Issues related to Error messages when code is wrong labels Jul 30, 2024

rix0rrr force-pushed the main branch 6 times, most recently from 674bb9f to 207fc8b Compare July 14, 2025 19:00

	msgstr "We detected that the `{repeat}` seems to be missing a `{command}` command, on line {line_number}. Can you try adding `{repeat}` with `{command}`?"
	msgstr "We detected that the `{repeat}` on line {line_number} is missing a `{command}` command. Can you try adding `{repeat}` with `{command}`?"

	msgstr "We detected that `{command}` may not be used with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"
	msgstr "We detected a `{command}` that can't be used with `{invalid_argument}`. Can you try changing `{invalid_argument}` to {allowed_types}?"

Uh oh!

Conversation

ghost commented Jun 27, 2024 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Felienne left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpelay commented Jun 28, 2024

Uh oh!

jpelay commented Nov 27, 2024

Uh oh!

Felienne commented Nov 28, 2024

Uh oh!

jpelay commented Nov 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ghost commented Jun 27, 2024 •

edited by ghost

Loading