fix: avoid leaking wrapper space from doc comment code block formatting#6851
Open
utakotoba wants to merge 2 commits intorust-lang:mainfrom
Open
fix: avoid leaking wrapper space from doc comment code block formatting#6851utakotoba wants to merge 2 commits intorust-lang:mainfrom
utakotoba wants to merge 2 commits intorust-lang:mainfrom
Conversation
rustbot
added
the
S-waiting-on-review
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
fixes #6832
Summary
Fixes a bug in doc comment code block formatting where
rustfmtcan introduce a trailing space and then report left behind trailing whitespace (iferror_on_unformatted = true).This happens with the following configuration:
Fix
Handle the single-line wrapped case when extracting the formatted code block body so wrapper-added whitespace is not preserved in the returned snippet.
The current fix is narrowly scoped to catch only single-line functions in doc comments. A simpler solution would be to wrap the final result with
remove_trailing_white_spaces(), but I don’t think it’s ideal since it would somehow impact more cases.