Improve error message language and polishing #5635
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 <[email protected]>
Co-authored-by: Jesús Pelay <[email protected]>
Co-authored-by: Jesús Pelay <[email protected]>
Co-authored-by: Jesús Pelay <[email protected]>
Co-authored-by: Jesús Pelay <[email protected]>
…nto Artun-test-branch
Felienne
reviewed
Jun 28, 2024
|
|
||
| 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}`?" |
There was a problem hiding this comment.
The 'seems to be' part is a bit long and doen not add something perse. We could make it shorter without losing info?
There was a problem hiding this comment.
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
reviewed
Jun 28, 2024
|
|
||
| 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}`?" |
There was a problem hiding this comment.
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
reviewed
Jun 28, 2024
|
|
||
| msgid "Invalid" | ||
| msgstr "We detected that `{invalid_command}` is not a Hedy level {level} command. Can you try using `{guessed_command}`?" | ||
|
|
||
| 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}?" |
There was a problem hiding this comment.
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
requested changes
Jun 28, 2024
|
|
||
| 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}?" |
There was a problem hiding this comment.
The may phrasing is a bit weird. I think we should rephrase (see above)
|
|
||
| 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?\"" |
|
|
||
| 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?" |
There was a problem hiding this comment.
Here we are removing try, which is think is good, but it still is there in other places.
|
|
||
| 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}?" |
There was a problem hiding this comment.
may does not mean what you think is means. Can't is fine as it is!
|
|
||
| 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." |
There was a problem hiding this comment.
is error better than mistake? Why?
|
|
||
| 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?" |
There was a problem hiding this comment.
is is more concise then seems to?
|
|
||
| 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?" |
There was a problem hiding this comment.
well it is possible, because the kid did it :)
Maybe we can say: which hedy can't process or something like that?
I also like the way we are working on the error messages! |
jpelay
added
content
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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