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 incorrect documentation URLs when using rubocop --show-docs-url #178

Merged
merged 1 commit into from Aug 26, 2022

Conversation

r7kamura
Copy link
Contributor

Added DocumentationBaseURL for rubocop --show-docs-url [COP1,COP2,...] command to work correctly for rubocop-minitest cops.

Before

$ bundle exec rubocop --show-docs-url Minitest/AssertEmpty
https://docs.rubocop.org/rubocop/cops_minitest.html#minitestassertempty

After

$ bundle exec rubocop --show-docs-url Minitest/AssertEmpty
https://docs.rubocop.org/rubocop-minitest/cops_minitest.html#minitestassertempty

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 Aug 24, 2022

Is the following issue resolved?
rubocop/rubocop-rails#756 (comment)

@r7kamura r7kamura changed the title Add DocumentationBaseURL Fix incorrect documentation URLs when using rubocop --show-docs-url Aug 24, 2022
Comment on lines 3 to 6
Include:
- '**/test/**/*'
- '**/*_test.rb'
DocumentationBaseURL: https://docs.rubocop.org/rubocop-minitest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's just my two cents.

Suggested change
Include:
- '**/test/**/*'
- '**/*_test.rb'
DocumentationBaseURL: https://docs.rubocop.org/rubocop-minitest
DocumentationBaseURL: https://docs.rubocop.org/rubocop-minitest
Include:
- '**/test/**/*'
- '**/*_test.rb'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@r7kamura Ping :-)

@koic koic merged commit 620c817 into rubocop:master Aug 26, 2022
@koic
Copy link
Member

koic commented Aug 26, 2022

Thanks!

@r7kamura r7kamura deleted the feature/url branch August 26, 2022 21:03
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