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 #649

Closed
wants to merge 1 commit into from

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:
issue


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.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
    • [-] If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@koic
Copy link
Member

koic commented Mar 7, 2022

Same as rubocop/rubocop#10444 (comment).

@ydah
Copy link
Member Author

ydah commented Mar 7, 2022

Thank you for your time, it is much appreciated.
This PR is closed as it will be resolved by rubocop/rubocop#10444

Because the rubocop/cops_documentation_generator is used below.

require 'rubocop/cops_documentation_generator'
YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
task.files = ['lib/rubocop/cop/**/*.rb']
task.options = ['--no-output']
end
task update_cops_documentation: :yard_for_generate_documentation do
deps = ['Rails']
# NOTE: Update `<<next>>` version for docs/modules/ROOT/pages/cops_rails.adoc
# when running release tasks.
RuboCop::Rails::Inject.defaults!
CopsDocumentationGenerator.new(departments: deps).call

@ydah ydah closed this Mar 7, 2022
@ydah ydah deleted the fix-doc-formatting branch March 7, 2022 12:13
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