Improve readability of error messages #52
Merged
Conversation
This file contains hidden or 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
I think this makes the error message stand out a little better and more readable.
A link to the documentation for this file will ensure that the library maintainer understands the problem and how to fix it.
GitHub Flavored Markdown automatically linkifies URLs and web addresses. A link is a "click me" signal to the reader. In this case, there is no reason for the reader to visit the web address. The error message is only displaying it to make it clear what is being referred to. So the linkification actually has a harmful effect on readability and might sidetrack the reader.
per1234
added
type: enhancement
silvanocerza
approved these changes
Jul 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.