fix: mark --rulesdir option as deprecated in CLI docs #15310
Merged
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain: Update docs and CLI option guide to note that
--rulesdir
is deprecated. (It has been considered deprecated for some time but these docs were missing that info.)What changes did you make? (Give an overview)
Update docs and CLI option guide to note that
--rulesdir
is deprecated. (It has been considered deprecated for some time but these docs were missing that info.)This is effectively a docs change, but commit is tagged as
fix:
due to changing code. The code change is just to reorder options (moving deprecated option to bottom of category) and adding deprecation note to help string.Is there anything you'd like reviewers to focus on?
Any concerns with reordering the options?
Can the CLI help string changes be improved, to maximize both readability and brevity?