Allow excluding some constants from Style/Documentation #9219
Conversation
|
Thanks, updated according to comments |
|
The CI build is currently failing. |
Indeed. It appears this is because I modified the BTW, should I add a |
That'd be fine. Sorry about the radio silence. I somehow forgot I had to respond here. |
|
Thanks, I updated the PR. I had to extract a |
|
The CI is failing and I see there's a conflict in one of the specs. |
For example, a very common idiom is to define a ClassMethods module that contains the class methods created by the parent module. In such cases, it might be desired to document the parent module, but not the ClassMethods module.
|
Thanks! |
This commit fixes the following build error.
```console
% cd path/to/rubocop
% bundle exec rake
(snip)
==> Failures
1) RuboCop Project Changelog future entries For
/Users/koic/src/github.com/rubocop/rubocop/spec/../changelog/new_allow_excluding_some_constants_from.md
entry link to related issue has a valid URL
Failure/Error: expect(issue[:url]).to match(pattern)
expected "#9219" to
match
/^https:\/\/github\.com\/rubocop\/rubocop\/(?:issues|pull)\/9219$/
Diff:
@@ -1 +1 @@
-/^https:\/\/github\.com\/rubocop\/rubocop\/(?:issues|pull)\/9219$/
+"#9219"
Shared Example Group: "has Changelog format" called from
./spec/project_spec.rb:261
# ./spec/project_spec.rb:192:in `block (6 levels) in
<top (required)>'
# ./spec/project_spec.rb:188:in `each'
# ./spec/project_spec.rb:188:in `block (5 levels) in
<top (required)>'
# tasks/spec_runner.rake:70:in `run_worker'
# tasks/spec_runner.rake:30:in `block in run_specs'
# tasks/spec_runner.rake:44:in `with_encoding'
# tasks/spec_runner.rake:28:in `run_specs'
# tasks/spec_runner.rake:116:in `block in <top (required)>'
1 deprecation logged to /tmp/test_queue_worker_88506_output
```
For example, a very common idiom is to define a ClassMethods module that
contains the class methods created by the parent module. In such cases,
it might be desired to document the parent module, but not the
ClassMethods module.
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.