-
-
Notifications
You must be signed in to change notification settings - Fork 272
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
Cop Idea: prevent "it works" description #1337
Comments
Sounds great. Would you like to open a PR with such a cop? It should be an easy one. There's |
It can have a configuration for disallowed patterns |
That would be my first cop but there's no rush so yeah I can do it someday. |
took a stab at this cop requirement! happy to make any changes! |
…_cop_to_call_out_insufficient_descriptions [Fix #1337] Update the cop to raise error for insufficient descriptions.
I see too many this:
Specs are not just here to prevent bugs, but are, as the name implies, specifications. In other words, a documentation we can use as developer to understand what the code is supposed to do.
So it could be nice to enforce a description of "what it does". Preventing "it works" would be a good start 😋
The text was updated successfully, but these errors were encountered: