Don't alter doc line comments unnecessarily. #581
Merged
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
Since we introduced the new logic to parse doc comments, the `UseTripleSlashForDocumentationComments` rule started inadvertently normalizing comments that were already doc line comments. For example, ```swift /// /// Foo /// ``` would have its initial blank line(s) and leading spaces removed, leaving this: ```swift /// Foo /// ``` While we may want to be opinionated at some point about how such comments are formatted, it's not a desired consequence of *this* rule; the name on the tin doesn't say anything about altering comments that already meet the requirement, so now we make sure to leave them alone if they're already doc line comments.
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.
Since we introduced the new logic to parse doc comments, the
UseTripleSlashForDocumentationCommentsrule started inadvertently normalizing comments that were already doc line comments. For example,would have its initial blank line(s) and leading spaces removed, leaving this:
While we may want to be opinionated at some point about how such comments are formatted, it's not a desired consequence of this rule; the name on the tin doesn't say anything about altering comments that already meet the requirement, so now we make sure to leave them alone if they're already doc line comments.