docs(Diagnostic): explain severity levels #92
Merged
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
favonia
force-pushed
the
document-severity
branch
from
7622720 to
98e2667
Compare
|
Since the main intended use-case is diagnostics for compilers and typecheckers, I suggest it would be helpful to be more explicit that a "Bug" refers to a bug in the compiler, while the "end user" in the description of "Error" refers to the user of the compiler, i.e. the programmer writing in the language being compiled. I also wouldn't personally describe a "Warning" as any kind of "error". |
favonia
force-pushed
the
document-severity
branch
from
98e2667 to
6cacb10
Compare
favonia
changed the title
Thanks to @mikeshulman for various suggestions.
favonia
force-pushed
the
document-severity
branch
from
6a1caad to
19dbb04
Compare
mikeshulman
reviewed
Oct 9, 2023
Co-authored-by: Mike Shulman <[email protected]>
|
@mikeshulman I'll assume you are okay with other text and merge this. |
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.
Close #86. @TOTBWF are you aware of any guideline or document on this? How did you get your impression?