- Notifications
You must be signed in to change notification settings - Fork48
fix: Tweak rendering ofsource when it's a single ASCII whitespace#169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
BurntSushi wants to merge1 commit intorust-lang:masterChoose a base branch
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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
This PR includes a small fix (that I am not at all sure about) and aregression test that fails on current master.The input here is just a single ASCII whitespace with an annotationpointing to immediately after that whitespace. In current master, itgets rendered like this:```error: missing trailing newline at end of file |1 | ... | ^ W292 | = help: Add trailing newline```But I think the insertion of an ellipsis here is not quite right. I wascertainly confused by the output.I don't really understand the formatting code at all, but I believe theellipsis is being inserted by this code:```rustif self.margin.was_cut_left() { // We have stripped some code/whitespace from the beginning, make it clear. buffer.puts(line_offset, code_offset, "...", *lineno_color);}```And `self.margin.was_cut_left()` was returning true because`computed_left` was set to `18446744073709551593`. This kind of value_seems_ like a bug, although some margin values are explicitlyinitialized to `usize::MAX`, so maybe not.Anywho, I tried removing the condition gating the setting of`whitespace_margin`, and that seems to fix this specific case withoutany other _known_ regressions (including across all of `ruff`'s testsuite), but this was mostly a result of me feeling around in the darkhere.910bfef tob1c4112CompareBurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 8, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 8, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 8, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
source when it's a single ASCII whitespacesource when it's a single ASCII whitespaceBurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 9, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 10, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 13, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 14, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 14, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 15, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
BurntSushi added a commit to astral-sh/ruff that referenced this pull requestJan 15, 2025
…ourceThe change to the rendering code is elaborated on in more detail here,where I attempted to upstream it:rust-lang/annotate-snippets-rs#169Otherwise, the snapshot diff also shows a bug fix: a `^` is now renderedwhere as it previously was not.
The renderer was rewritten with 0.12. We should verify if this is still a problem. |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
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.
This PR includes a small fix (that I am not at all sure about) and a
regression test that fails on current master.
The input here is just a single ASCII whitespace with an annotation
pointing to immediately after that whitespace. In current master, it
gets rendered like this:
But I think the insertion of an ellipsis here is not quite right. I was
certainly confused by the output.
I don't really understand the formatting code at all, but I believe the
ellipsis is being inserted by this code:
And
self.margin.was_cut_left()was returning true becausecomputed_leftwas set to18446744073709551593. This kind of valueseems like a bug, although some margin values are explicitly
initialized to
usize::MAX, so maybe not.Anywho, I tried removing the condition gating the setting of
whitespace_margin, and that seems to fix this specific case withoutany otherknown regressions (including across all of
ruff's testsuite), but this was mostly a result of me feeling around in the dark
here.