[Fix #2968] Added DocumentationMethod Cop. #3296
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
sooyang
force-pushed
the
feature/documentation_method
branch
from
3b8c205
to
cad15e1
Compare
| class DocumentationMethod < Cop | ||
| include AnnotationComment | ||
|
|
||
| MSG = 'Missing top-level %s documentation method comment.'.freeze |
There was a problem hiding this comment.
I don't quite get this message. I'd go for "Missing documentation comment for public method.".
|
@sooyang ping :-) |
sooyang
force-pushed
the
feature/documentation_method
branch
from
cad15e1
to
412ffc0
Compare
| @@ -1,6 +1,7 @@ | |||
| # Change log | |||
|
|
|||
| ## master (unreleased) | |||
| * [#2968](https://github.com/bbatsov/rubocop/issues/2968): Add new `Style/DocumentationMethod` cop. ([@sooyang][]) | |||
There was a problem hiding this comment.
This should be under New features.
sooyang
force-pushed
the
feature/documentation_method
branch
from
412ffc0
to
103b6aa
Compare
|
@bbatsov added |
| @@ -10,6 +10,7 @@ | |||
| * Add new `Style/TernaryParentheses` cop. ([@drenmi][]) | |||
| * [#3136](https://github.com/bbatsov/rubocop/issues/3136): Add config for `UselessAccessModifier` so it can be made aware of ActiveSupport's `concerning` and `class_methods` methods. ([@maxjacobson][]) | |||
| * [#3128](https://github.com/bbatsov/rubocop/issues/3128): Add new `Rails/SaveBang` cop. ([@QuinnHarris][]) | |||
| * [#2968](https://github.com/bbatsov/rubocop/issues/2968): Add new `Style/DocumentationMethod` cop. ([@sooyang][]) | |||
There was a problem hiding this comment.
You'll have to move this to the master branch. We just released 0.42.
sooyang
force-pushed
the
feature/documentation_method
branch
from
103b6aa
to
47ad567
Compare
|
@bbatsov moved |
Neodelf
pushed a commit
to Neodelf/rubocop
that referenced
this pull request
Oct 15, 2016
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 cop checks for missing top-level documentation of methods as suggested in issue #2968.
The default is set to false due to pre-existing methods that do not contain the top-level documentation.
Private and Protected methods will not be scanned.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).and description in grammatically correct, complete sentences.