Revise all error messages adopting usability pattern #1019
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
aslesarenko
requested changes
Jul 16, 2024
| case _ => sys.error("Unsupported scala version") | ||
| case _ => sys.error("The Scala version you are using is not supported. " + | ||
| "Please use one of the supported versions: Scala 2.11, 2.12, or 2.13. " + | ||
| "If the issue keeps happening, contact <a href=\"#\">Customer care</a>.") |
There was a problem hiding this comment.
- for the "Help them fix it" part, an instruction of which SBT variable should be checked for the current version.
- Also there is no "Customer care", only Discord channels. (this also applies to all the other messages)
| case _ => sys.error(s"Collection value $c has unexpected type $tpe") | ||
| case _ => sys.error(s"The value in the collection $c is not the correct type: $tpe. " + | ||
| "Please make sure the value is of the correct type. " + | ||
| "If the issue keeps happening, contact <a href=\"#\">Customer care</a>.") |
There was a problem hiding this comment.
The meaning of the message has been changed, which makes it less clear (despite many more words).
Please see how the method is used to come up with a clarifying message.
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.
### Changes Made:
Note: Currently using “#” in place for a link to contact customer support