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.
Broken note
A typographic quote in
seems to have broken the parsing of backticks. You may see that the text between
Includes
is wrapped into monospace code section, and the second backtick of the second backtick on the lastIncludes
is missing.We have had this issue with regular single quotes, that's why we've used a typographic one here. But the problems either affects both, or it started to with Antora version update.
Broken sub-department cops docs
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
vscops_docs/
name clash.Suspect: https://docs.antora.org/antora/2.3/page/page-id/#important
Ideally, we would generate
cops_rspec_capybara.adoc
instead ofcops_rspec/capybara.adoc
.I've tracked it down to this method in RuboCop:
Any suggestions? I've sent a PR to RuboCop to update this to change
downcase
todowncase.tr('/', '_')
.Other RuboCop extensions don't seem to make use of sub-departments, and will be unaffected by this change.
Docs in the second commit are generated using the patched RuboCop.
Before submitting the PR make sure the following are checked:
master
(if not - rebase it).CHANGELOG.md
if the new code introduces user-observable changes.bundle exec rake
) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).