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

Reorganize RuboCop help into sections for better clarity #10132

Merged
merged 1 commit into from Sep 28, 2021

Conversation

dvandersluis
Copy link
Member

@dvandersluis dvandersluis commented Sep 27, 2021

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).

image

(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:

  • 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.

@dvandersluis
Copy link
Member Author

Related general question: is it time to make the lines in --help longer? They're roughly trimmed to ~85 characters, but it makes --help very tall.

Copy link
Collaborator

@bbatsov bbatsov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done! I think it's fine to stick with the current text wrapping, as I'm not sure how longer text will look in (real) text consoles.

@bbatsov bbatsov merged commit 1ea71be into rubocop:master Sep 28, 2021
@dvandersluis
Copy link
Member Author

dvandersluis commented Sep 29, 2021

Apparently I forgot to add a changelog file for this 🤔

@bbatsov
Copy link
Collaborator

bbatsov commented Sep 29, 2021

You can just edit the changelog end the release notes directly.

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