Align the short and long forms into their own columns in the help output #145
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…put.
This makes displaying a mixed set of parameters cleaner and easier to understand. This is in line with the behavior of common GNU tools such as rsync.
Old way:
```
Options:
-i, --init Creates a skeleton config file in the current working directory
-v, --verbose Enables verbose output. Twice will enable very-verbose output (good for logging)
-y, --yes Assume 'yes' to all questions for headless execution
--yaml=<s> Specify a yaml file to load
-h, --help Show this message
```
New way:
```
Options:
-i, --init Creates a skeleton config file in the current working directory
-v, --verbose Enables verbose output. Twice will enable very-verbose output (good for logging)
-y, --yes Assume 'yes' to all questions for headless execution
--yaml=<s> Specify a yaml file to load
-h, --help Show this message
```
|
Sorry guys, just a few minutes and I'll have the tests sorted out. Slipped by me. |
|
Done. The remaining tests that are failing seem to be for unrelated issues. |
|
If there are only long forms, is the whole output kind of indented? |
|
I can't seem to test that in the real world as there's always a line that says |
|
Yeah you're right, at least not without some hackery. A user can override the message for help, and they can override the short form of help, but they can't remove the short form. |
Fryguy
approved these changes
Apr 26, 2024
Fryguy
added a commit
that referenced
this pull request
Nov 11, 2024
Added: - Align the short and long forms into their own columns in the help output (#145 - thanks akhoury6) - Add support for DidYouMean when long options are spelled incorrectly (#150 - thanks nanobowers) - Using `permitted:` restricts the allowed values that a end-user inputs to a pre-defined list (#147 - thanks akhoury6) - Add exact_match to settings, defaulting to inexact matching (#154 - thanks nanobowers) - Add setting to disable implicit short options (#155 - thanks nanobowers) - Add alt longname and multiple char support (#151 - thanks nanobowers) - Permitted regexp/range support (#158, #159- thanks nanobowers) - Add some examples (#161 - thanks nanobowers) Changed: - Enable frozen_string_literal for future-ruby support (#149, #153 - thanks nanobowers) - Refactor constraints (#156 - thanks nanobowers) - Fix assert_raises to assert_raises_errmatch (#160 - thanks nanobowers)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes displaying a mixed set of parameters cleaner and easier to understand. This is in line with the behavior of common GNU tools such as rsync.
Old way:
New way: