Convert another doc comment rule to opt-in and fix some typos. #248
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
This converts the rule `BeginDocumentationCommentWithOneLineSummary` to opt-in status. The linguistic APIs for sentence detection aren't available on Linux, and the rule creates a lot of noise and is inconsistent across platforms. This also fixes a few typos from doc comments explaining the opt-in status of some other rules.
allevato
approved these changes
Jan 12, 2021
aaditya-chandrasekhar
pushed a commit
to val-verde/swift-format
that referenced
this pull request
May 20, 2021
* Update Package.swift Update to the latest swift-log version. This is driven by the desire to build swift-doc on Windows, which requires a newer version of swift-log. This adjustment enables us to get further with building swift-doc on Windows. * Update Package.resolved Co-authored-by: Mattt <mattt@me.com>
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 converts the rule
BeginDocumentationCommentWithOneLineSummaryto opt-in status. The linguistic APIs for sentence detection aren't available on Linux, and the rule creates a lot of noise and is inconsistent across platforms.This also fixes a few typos from doc comments explaining the opt-in status of some other rules.