doc: Add diagnostics for Ruby page #1249
Merged
+3,111
−116
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
ParadoxV5
approved these changes
Oct 2, 2024
guides/src/diagnostics/ruby.md
Outdated
| # Diagnostics for Ruby | ||
| Each error description will follow the format below. | ||
|
|
||
| ```` |
There was a problem hiding this comment.
Suggested change
| ```` | |
| ````markdown |
guides/src/diagnostics/ruby.md
Outdated
Comment on lines
81
to
83
| | all_error | default | strict | lenient | silent | | ||
| | --- | --- | --- | --- | --- | | ||
| | error | warning | error | information | nil | |
There was a problem hiding this comment.
Looks like default is between strict and lenient.
Suggested change
| | all_error | default | strict | lenient | silent | | |
| | --- | --- | --- | --- | --- | | |
| | error | warning | error | information | nil | | |
| | all_error | strict | default | lenient | silent | | |
| | --- | --- | --- | --- | --- | | |
| | error | error | warning | information | nil | |
Also, I’m not sure if it’s necessary to include the all_error and silent severities, as they (should) set everything to error and nil respectively.
There was a problem hiding this comment.
Looks like
defaultis betweenstrictandlenient.
Thanks! I'll fix it.
Also, I’m not sure if it’s necessary to include the
all_errorandsilentseverities, as they (should) set everything toerrorandnilrespectively.
This was a point that bothered me too. I thought it would be valuable to have a list of error presets, so I'm listing them here, but I'd like to hear soutaro-san's thoughts.
When running steep check, various errors are displayed, but there is no clear explanation of what these errors mean. So I created a document for error reference. Japanese version: https://tech.timee.co.jp/entry/2024/10/02/153330
soutaro
force-pushed
the
doc-diagnostics-for-ruby
branch
from
07f4e1f to
bef05c5
Compare
soutaro
force-pushed
the
doc-diagnostics-for-ruby
branch
from
d5f0c73 to
efff0cc
Compare
soutaro
force-pushed
the
doc-diagnostics-for-ruby
branch
from
4241a59 to
b67f0d7
Compare
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.
When running steep check, various errors are displayed, but there is no clear explanation of what these errors mean.
So I created a document for error reference.
Japanese version: https://tech.timee.co.jp/entry/2024/10/02/153330