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

Improved CmdLine help message formatting #1054

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

Conversation

ahmadh84
Copy link

@ahmadh84 ahmadh84 commented Jul 3, 2017

Before, the -h help flag wrote each option in its own line as follows:

 -opt1    This is my long winded help message which requires more space and makes it ugly [default option for -opt1]
 -myopt2  help for myopt2 [default option for -myopt2]

These messages were extremely hard to read. This commit now breaks each
option help message as follows:

 -opt1    This is my long winded help message
          which requires more space and makes
          it ugly [default option for -opt1]
 -myopt2  help for myopt2 [default option for -myopt2]

This is done in a way to limit the help message to around 80 characters.

@ahmadh84 ahmadh84 force-pushed the cmdline_formatting branch from ff6de24 to 426424b Compare July 3, 2017 03:51
Before, the -h help flag wrote each option in its own line as follows:
 -opt1    This is my long winded help message which requires more space and makes it ugly [default option for -opt1]
 -myopt2  help for myopt2 [default option for -myopt2]
These messages were extremely hard to read. This commit now breaks each
option help message as follows:
 -opt1    This is my long winded help message
          which requires more space and makes
          it ugly [default option for -opt1]
 -myopt2  help for myopt2 [default option for -myopt2]

This is done in a way to limit the help message to around 80 characters.
@ahmadh84 ahmadh84 force-pushed the cmdline_formatting branch from 426424b to e633ad7 Compare July 3, 2017 03:59
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.

1 participant