asdf icon indicating copy to clipboard operation
asdf copied to clipboard

fix: make clearer help usage

Open mrjk opened this issue 2 years ago • 4 comments

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 avatar Nov 22 '23 16:11 mrjk

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.

hyperupcall avatar Nov 22 '23 18:11 hyperupcall

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 avatar Nov 23 '23 15:11 mrjk

Hi there, should I assume my PR is refused ?

Thanks

mrjk avatar Mar 30 '24 22:03 mrjk

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

hyperupcall avatar Mar 31 '24 14:03 hyperupcall