[Fix #11504] Allow initialize method in Style/DocumentationMethod
#11506
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
koic
force-pushed
the
allow_initialize_method_in_sytle_documentation_method
branch
from
e9f0187
to
735ba6d
Compare
…Method` Fixes rubocop#11504. This PR makes to allow `initialize` method in `Style/DocumentationMethod` because `initialize` is a special method called from `new`. In some languages they are called constructor to distinguish it from method. So it would be different from the following intent that this cop wants to detect. > Checks for missing documentation comment for public methods. > It can optionally be configured to also require documentation for > non-public methods.
koic
force-pushed
the
allow_initialize_method_in_sytle_documentation_method
branch
from
735ba6d
to
c9dd42d
Compare
|
Fine by me. Thanks! |
koic
deleted the
allow_initialize_method_in_sytle_documentation_method
branch
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.
Fixes #11504.
This PR makes to allow
initializemethod inStyle/DocumentationMethodbecauseinitializeis a special method called fromnew. In some languages they are called constructor to distinguish it from method.So it would be different from the following intent that this cop wants to detect.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.