Prettier warning output #18288
Merged
Prettier warning output #18288
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
awaelchli
force-pushed
the
feature/better-warning
branch
from
ac34427 to
dbc1ded
Compare
awaelchli
added
pl
|
My vote is (4) - thank you by the way for trying this, didn't know removing the leftover "rank_zero_only(" was possible - because a large percentage of terminals (if not most) will autowrap by default. And those who don't have it configured probably like that their lines do not wrap. One more suggestion from me would be to remove the warning category. We only use |
github-actions
bot
added
pl
Borda
approved these changes
Aug 15, 2023
carmocca
reviewed
Aug 15, 2023
awaelchli
force-pushed
the
feature/better-warning
branch
2 times, most recently
from
4639955 to
31114ed
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #18288 +/- ##
=========================================
- Coverage 85% 60% -25%
=========================================
Files 427 419 -8
Lines 33138 33017 -121
=========================================
- Hits 28188 19888 -8300
- Misses 4950 13129 +8179 |
awaelchli
force-pushed
the
feature/better-warning
branch
2 times, most recently
from
2a760d7 to
11905b2
Compare
awaelchli
force-pushed
the
feature/better-warning
branch
from
ad39540 to
6fde265
Compare
carmocca
reviewed
Sep 17, 2023
awaelchli
force-pushed
the
feature/better-warning
branch
from
89a6e5d to
2877985
Compare
awaelchli
force-pushed
the
feature/better-warning
branch
from
9f54d75 to
d0d6c4b
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.
What does this PR do?
This PR proposes a prettier warning printing. Currently, the user sees a warning formatted like this, with all the text crammed in a single line and a strange
rank_zero_warn(on a new line:In a normally sized terminal window, the filename can take up a big chunk of space. The user then only sees very little of the actual warning message, and has to scroll horizontally which could be considered annoying.
I experimented with custom formatting. Here are a few versions:
Version 1: Multi-line: Warning type on same line
Version 2: Multi-line: Warning type on new line
Version 3: Multi-line: With indentation
Version 4: Single line, but no awkward "rank_zero_only(" on new line
Please let me know whether you find this a good idea, you have any suggestions or if you see any problems with this formatting style.
cc @Borda @carmocca @justusschock @awaelchli