[Fix #12884] Allow cop_class.documentation_url to take a config
#12907
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Earlopain
force-pushed
the
documentation-url-config
branch
from
b4567f5
to
f3f0ffc
Compare
The current implementation is not very useful to consumers since it requires every extension to overwrite this method. No official extension currenty does that. The behaviour of `--show-docs-url` is almost what's required. It takes a config to construct this url. The url it provides falls back to the default RuboCop docs url which is undesirable in all cases I can think about. That behaviour has been removed.
Earlopain
force-pushed
the
documentation-url-config
branch
from
f3f0ffc
to
8033d49
Compare
|
Seems like a reasonable change to me. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #12884 (almost). It requires passing in a config object but that seems ok to require.
The current implementation is not very useful to consumers since it requires every extension to overwrite this method.
No official extension currenty does that.
The behaviour of
--show-docs-urlis almost what's required. It takes a config to construct this url and returns correct results for all official extensions.The url it provides falls back to the default RuboCop docs url which is undesirable in all cases I can think about. That behaviour has been removed. No 3rd-party extension cops will be found on the RuboCop docs website. Only buildin cops will be found there.
All extensions that provide
DocumentationBaseURLwill now have result returned bydocumentation_urlwithout needing to do something themselves (as long as proper config object is passed in)Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.