[READY FOR REVIEW] MONGOID-5570 Code Docs: 100% class/method documentation coverage 馃挴馃帀 #5546
Conversation
johnnyshields
changed the title
johnnyshields
changed the title
gemfiles/standard.rb
Outdated
| @@ -20,7 +20,7 @@ def standard_dependencies | |||
|
|
|||
| group :development, :test do | |||
| gem 'rspec-core', '~> 3.10' | |||
| gem 'rubocop', '~> 1.45.1' | |||
| gem 'rubocop', git: 'https://github.com/rubocop/rubocop.git' | |||
There was a problem hiding this comment.
Can be '~> 1.45.2' when released. Related to this fix: rubocop/rubocop@b46b9b5 which was discovered in the process of making this PR.
johnnyshields
changed the title
johnnyshields
changed the title
johnnyshields
changed the title
johnnyshields
changed the title
|
@johnnyshields this is a change we would prefer to introduce incrementally. MONGOID-5304 was merged and introduces static analysis, however we'd like to take some time to evaluate our options before enabling additional cops. I'm going to close this PR and MONGOID-5570 for the time being and we'll add additional tickets to the backlog as we introduce additional cops. We appreciate the amount of effort invested in updating all these source files, however we cannot accept this PR presently. |
|
@alexbevi would you accept this PR if I remove the Rubocop enablement? Documenting all these methods took a considerable amount of time and research and it would be a shame for it to go to waste. |
I'll discuss with the team, however we would need to validate each entry for accuracy as well so the time to review and merge such a large PR would not be insignificant. We may consider "peeling off" chunks of the PR incrementally as those code files are updated instead. |
|
Peeling off chunks is fine by me! |
This PR adds 100% coverage of class and method documentation.
This PR contains only doc comments; code was modified.
It also enables the following Rubocop cops, which will ensure coverage stays at 100%: