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

Merged
merged 1 commit into from Aug 24, 2022

Conversation

r7kamura
Copy link
Contributor

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

Before

$ bundle exec rubocop --show-docs-url Performance/AncestorsInclude
https://docs.rubocop.org/rubocop/cops_performance.html#performanceancestorsinclude

After

$ bundle exec rubocop --show-docs-url Performance/AncestorsInclude
https://docs.rubocop.org/rubocop-performance/cops_performance.html#performanceancestorsinclude

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 force-pushed the feature/url branch 2 times, most recently from 468773f to fc16ab8 Compare August 24, 2022 02:16
@r7kamura r7kamura changed the title Add DocumentationBaseURL Fix incorrect documentation URLs when using rubocop --show-docs-url Aug 24, 2022
@r7kamura r7kamura force-pushed the feature/url branch 2 times, most recently from 1d5fc9e to 008ed6d Compare August 24, 2022 05:26
@koic koic merged commit 84ac065 into rubocop:master Aug 24, 2022
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