feat: Add Renderer::cut_indicator
#172
Open
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
|
It might be good for there to be an issue for exploring this before moving onto a PR as this might run counter to some other goals
|
This adds a new API for overriding the use of `...` to indicate a cut or trimmed line. In the case of Ruff, we didn't want to use `...` since `...` is valid Python code. It could be rather confusing in some cases where `...` would be ambiguous between "line was cut here" and "this is what the actual line read as." I think this can happen with _any_ indicator of course, but for Python specifically, it's pretty likely to happen with `...`. The new API here is somewhat sub-optimal in that it requires a `&'static str`. I did this because of the constraints imposed by a `Renderer`'s `const` constructor.
BurntSushi
force-pushed
the
ag/custom-cut-indicator
branch
from
a7949be to
179098f
Compare
|
Aye, fair enough! I opened #174 for that. |
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 9, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 9, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 10, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 13, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 14, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
BurntSushi
added a commit
to astral-sh/ruff
that referenced
this pull request
Jan 14, 2025
We do this because `...` is valid Python, which makes it pretty likely that some line trimming will lead to ambiguous output. So we add support for overriding the cut indicator. This also requires changing some of the alignment math, which was previously tightly coupled to `...`. For Ruff, we go with `…` (`U+2026 HORIZONTAL ELLIPSIS`) for our cut indicator. For more details, see the patch sent to upstream: rust-lang/annotate-snippets-rs#172
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.
This adds a new API for overriding the use of
...to indicate a cut ortrimmed line. In the case of Ruff, we didn't want to use
...since...is valid Python code. It could be rather confusing in some caseswhere
...would be ambiguous between "line was cut here" and "this iswhat the actual line read as." I think this can happen with any
indicator of course, but for Python specifically, it's pretty likely to
happen with
....The new API here is somewhat sub-optimal in that it requires a
&'static str. I did this because of the constraints imposed bya
Renderer'sconstconstructor.