Fix for 4824 - multi comments cause internal error #5502
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
ytmimi
reviewed
Aug 25, 2022
src/missed_spans.rs
Outdated
Comment on lines
281
to
284
|
|
||
| let other_lines = &subslice[offset + 1..]; | ||
| let other_lines = &subslice[offset + 1..].trim_start(); | ||
| let comment_str = | ||
| rewrite_comment(other_lines, false, comment_shape, self.config) | ||
| .unwrap_or_else(|| String::from(other_lines)); | ||
| .unwrap_or_else(|| other_lines.to_string()); |
There was a problem hiding this comment.
Does it make sense to trim the start of the comment if we fail to rewrite it? By the time we call unwrap_or_else other_lines has already been trimmed. Maybe we should leave the string alone if rewrite_comment fails?
let other_lines = &subslice[offset + 1..];
let comment_str =
rewrite_comment(other_lines.trim_start(), false, comment_shape, self.config)
.unwrap_or_else(|| other_lines.to_string());There was a problem hiding this comment.
Agree this is better. Changed.
|
For what it's worth, I had a similar idea of removing the leading whitespace in #5392. |
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.
Closes #4824
The suggested fix is in two code changes done for Version Two - by adding
trim_start()before passing a comments string torewrite_comment().A more robust fix may be to do the
trim_start()(or eventrim()) insiderewrite_comment()(for Version Two), but I didn't evaluate the overall use ofrewrite_comment()to make sure this is o.k.