Fix default rules section in documentation #3857
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
While browsing the rules documentation, I noticed **many** rules were both in the Default Rules and in the Opt In Rules section. After looking into it, the docs of the `drop(while predicate: (Element) throws -> Bool` function states: A closure that takes an element of the sequence as its argument and returns true if the element should be skipped or false if it should be included. **Once the predicate returns false it will not be called again.** This caused the `defaultRuleDocumentations` array to contain almost all `ruleDocumentation`. This commit fixes it.
Generated by 🚫 Danger |
rcole34
pushed a commit
to rcole34/SwiftLint
that referenced
this pull request
Feb 22, 2022
While browsing the rules documentation, I noticed **many** rules were both in the Default Rules and in the Opt In Rules section. After looking into it, the docs of the `drop(while predicate: (Element) throws -> Bool` function states: A closure that takes an element of the sequence as its argument and returns true if the element should be skipped or false if it should be included. **Once the predicate returns false it will not be called again.** This caused the `defaultRuleDocumentations` array to contain almost all `ruleDocumentation`.
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.
While browsing the rules documentation, I noticed many rules were both in the Default Rules and in the Opt In Rules section.
I ran the generate-docs command and found the following:
The numbers confirm they don't add up.
After looking into it, the docs of the
drop(while predicate: (Element) throws -> Bool)function explains why:This caused the
defaultRuleDocumentationsarray to contain almost allruleDocumentation.This PR fixes it: