[doc] Include deprecated rule references in documentation (Fixes #2823)#2824
Merged
Conversation
This reverts commit ec2b3d8.
Uses the pattern documented in rule deprecation policy. The rule reference should be deprecated to get a deprecation warning, if it is still used.
Include deprecated rule references conditionally when loading rulesets via RuleSetFactory
Generated by 🚫 Danger |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Describe the PR
There was no possibility yet to create a RuleSetFactory that would load deprecated rule references. These were always
ignored, which is correct for the default case. But for generating documentation, we want to have the complete "raw"
ruleset.
This adds one more public method to
RulesetsFactoryUtilswith an additional flag.Related issues
Ready?
./mvnw clean verifypasses (checked automatically by travis)