Fix sub-department cop doc generation #10013
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
If you go to https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html, links to the second-level cops docs are broken. The last one is correct, https://docs.rubocop.org/rubocop-rspec/2.0/cops_rspec.html, while others have anchors, e.g. https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html#cops_capybara.adoc. This is probably due to `cops_docs.adoc` vs `cops_docs/` name clash. Suspect: https://docs.antora.org/antora/2.3/page/page-id/#important Ideally, we would generate `cops_rspec_capybara.adoc` instead of `cops_rspec/capybara.adoc.` Other RuboCop extensions don't seem to make use of sub-departments, and will be unaffected by this change.
3 tasks
koic
reviewed
Aug 14, 2021
| @@ -8,7 +8,7 @@ module Documentation | |||
|
|
|||
| # @api private | |||
| def department_to_basename(department) | |||
| "cops_#{department.downcase}" | |||
| "cops_#{department.to_s.downcase.tr('/', '_')}" | |||
There was a problem hiding this comment.
Yes. department is surprisingly a Symbol. downcase (not less surprisingly to me) works on Symbol, but tr doesn't.
I don't have a strong preference where to add .to_s, before or after downcase.
Also, I'll be happy to extract this transformation to a variable for better readability if you see fit.
There was a problem hiding this comment.
I get it! This is fine, thank you for your explanation.
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.
If you go to https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html, links to the second-level cops docs are broken. The last one is correct, https://docs.rubocop.org/rubocop-rspec/2.0/cops_rspec.html, while others have anchors, e.g. https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html#cops_capybara.adoc. This is probably due to
cops_docs.adocvscops_docs/name clash.Suspect: https://docs.antora.org/antora/2.3/page/page-id/#important
Ideally, we would generate
cops_rspec_capybara.adocinstead ofcops_rspec/capybara.adoc.Other RuboCop extensions don't seem to make use of sub-departments, and will be unaffected by this change.
Related PR rubocop/rubocop-rspec#1183
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.