-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
False positive missing_docs with Swift 2.3 #855
Comments
We're seeing similar behaviour except its public properties // An object describing a round within a bracket
public class Round {
/// true if the round is the final round within the bracket, false otherwise.
public var finals: Bool = false
} For us it looks as though the difference between Xcode and command line is probably because we have swiftlint running in the main app targets build phase but the model is part of another target. Either way the class and properties are documented and swiftlint is reporting failures |
Well, I had to stop using this rule, because it's made my builds on Bamboo fail :/ |
The title of this issue says Swift 2.3, but the original comment says Swift 3.0. Is it happening for both? |
We are seeing the issue with Swift 2.3, can't speak to wether or not it affects 3.0 |
@nhgrif Oh, man. It was a mistake. It's Swift 2.3 |
This is a duplicate of #728. Please see my comment there (#728 (comment)) for more details and suggestions on how to resolve the situation. Thanks! |
I'm using Xcode 8 with Swift 2.3. Here's the class:
When I build the project in Xcode, it passes swxftlint phase without any warnings (other warnings appear, it's just missing_docs problem)
When I run swiftlint in console, that's what I get:
/Users/[...]/Pod/Classes/SampleClass.swift:12:8: warning: Missing Docs Violation: Public declarations should be documented. (missing_docs)
So I guess console gives me false positive missing_docs, because the class and functions are described.
The text was updated successfully, but these errors were encountered: