Fix misidentification of indented comments #6617
Open
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
The comment style detection (i.e. `comment_style`) checks the start of a line to determine the style, so it will misidentify lines starting with spaces, e.g. ` //# some content` would be identified as `CommentStyle::DoubleSlash` and not `CommentStyle::Custom("//# ")` resulting in it determining there to be a comment of `""`, which it then indents and appends a `\n` before writing back the original comment. Fix this by trimming the line before trying to identify its style. Fixes: rust-lang#6612 
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.
The comment style detection (i.e.
comment_style) checks the start of a line to determine the style, so it will misidentify lines starting with spaces, e.g.//# some contentwould be identified asCommentStyle::DoubleSlashand notCommentStyle::Custom("//# ")resulting in it determining there to be a comment of"", which it then indents and appends a\nbefore writing back the original comment.Fix this by trimming the line before trying to identify its style.
Fixes: #6612