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

fix: make clearer help usage #1682

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: make clearer help usage #1682

wants to merge 1 commit into from

Conversation

mrjk
Copy link

@mrjk mrjk commented Nov 22, 2023

Summary

Fixes: help usage is difficult to read and quite bulky

Other Information

I propose this PR that just reorganize a bit command help message in a more logical way (to me at least). Also, there is more spacing and indentation that make the whole mere readable and understandable. Feel free to comment if you have other opinion on this topic :)

@mrjk mrjk requested a review from a team as a code owner November 22, 2023 16:32
@hyperupcall
Copy link
Contributor

hyperupcall commented Nov 22, 2023

Currently, the help menu is organized alphabetically, by category. And I do prefer older way of styling the category title (by capitalization). Changing the help menu is a big change, because many are used to the positions (or memorize the positions) of certain commands, and this would disrupt that. In my opinion, I think it should only be changed if there is consensus. But I'm not a maintainer, only a frequent contributor.

@mrjk
Copy link
Author

mrjk commented Nov 23, 2023

Thanks for your feedback :) This commit changes only 4 things:

  1. Add dashes after titles
  2. Indent content from title
  3. Add one extra space before "sub-sections" and titles
  4. Reorganize sections order

I feel a good --help is the one you don't have to look every time you want to use the program; if the help message is confusing, either people won't be able to use easily the program, either they find something else. Also, reformatting help message is probably the less disruptive change in an app lifecycle, especially if it can improve user comprehension :p

Anyway, I'm completely open to keep only some of these change, but eventually, I would go AT LEAST with point 1 and 2, and check if point 3 or 4 are "too disruptive".

Tell me what fit the best to the community :)

@mrjk
Copy link
Author

mrjk commented Mar 30, 2024

Hi there, should I assume my PR is refused ?

Thanks

@hyperupcall
Copy link
Contributor

@mrjk This project isn't maintained as much as it used to be. Sometimes even important PRs take a bit longer to be reviewed. I'm only someone who used to frequently contribute.

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.

2 participants