Skip to content
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

Inconsistent "missing_docs" warnings #1330

Closed
jpipard opened this issue Feb 22, 2017 · 3 comments
Closed

Inconsistent "missing_docs" warnings #1330

jpipard opened this issue Feb 22, 2017 · 3 comments

Comments

@jpipard
Copy link

jpipard commented Feb 22, 2017

Hello all :-)
We get a lot of "missing_docs" warnings in our project. But we don't understand why. We installed SwiftLint via cocoapods pod 'SwiftLint', '~> 0.16.1'.

1. Here's the first example :
For this example, I don't understand why the comment for addConstraint is fine but not the one for removeContraint

image

2. And here's a second example for a struct :
image

Is there something missing in my comments formats ?
Thank you for your help!

@jpipard
Copy link
Author

jpipard commented Feb 22, 2017

seems to be related to #728

@mgrebenets
Copy link
Contributor

Same for us, this seems to be an old issue and it wasn't fixed when we moved onto Swift 3.
For now we had to disable missing_docs...

@jpsim
Copy link
Collaborator

jpsim commented Mar 10, 2017

That's right, this was tracked as #728 and the rules ultimately disabled for Swift 2.3+.

@jpsim jpsim closed this as completed Mar 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants