Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc formatting written in unescaped file path #10444

Merged
merged 1 commit into from Mar 7, 2022

Conversation

ydah
Copy link
Member

@ydah ydah commented Mar 7, 2022

This fixes an issue where file paths were not escaped and were displayed as follows:
sample


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
    • [-] Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
    • [-] Added tests.
    • [-] Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
    • [-] Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

@koic
Copy link
Member

koic commented Mar 7, 2022

docs/modules/ROOT/pages/cops_#{department}.adoc are documents generated by CopsDocumentationGenerator. So, CopsDocumentationGenerator needs to be fixed because regression will occur even if docs/modules/ROOT/pages/cops_#{department}.adoc are fixed directly.
https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cops_documentation_generator.rb

@ydah
Copy link
Member Author

ydah commented Mar 7, 2022

I updated this PR. Thanks a lot!

docs/modules/ROOT/pages/cops_#{department}.adoc are documents generated by CopsDocumentationGenerator. So, CopsDocumentationGenerator

I have referred to #10405 in preparing this PR. I missed it💦

@koic koic merged commit 105f94c into rubocop:master Mar 7, 2022
@koic
Copy link
Member

koic commented Mar 7, 2022

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants