Reorganize RuboCop help into sections for better clarity #10132
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.
As demonstrated here for example, we have a lot of CLI options, and they're not always easily findable or understandable from
--help
. This is not very friendly for RuboCop beginners, in particular.This change reorganizes the options into logical groups, does some minor rewording of options I thought were a bit unclear, and also adds some basic colouring (the section headings are made bright).
(This is some, but not nearly all, of the help)
Happy to take any suggestions for further rewording, different ordering of sections or within sections (I tried to make it flow logically), etc.
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}.md
if the new code introduces user-observable changes. See changelog entry format for details.