-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
default short help is too short #936
Comments
Do I understand correctly that there is currently no way to specify a width for short help? |
fdavis
added a commit
to fdavis/click
that referenced
this issue
May 14, 2018
to address pallets#936 and related issues it seems cleaner to remove this function and let the formatter print the command block
fdavis
added a commit
to fdavis/click
that referenced
this issue
May 15, 2018
try to address the too short short_help width as requested in pallets#936
Merged #1002 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
My CLI tool has many commands with help strings. These are single sentences, intended to display on the command list page. I expect that if my terminal is wide enough,
program --help
will show full help strings for the commands. Instead, they are arbitrarily shortened after reaching 45 characters, regardless of terminal width andmax_content_width
of the context (as seen in #441).I think I understand the intention behind separating
help
andshort_help
, and shortening the help if no separateshort_help
exists. I'd expect one of two things, though:max_content_width
to short help and shortening based on terminal size,short_help
in place ofhelp
if the latter is not specified. As in, if I want the short and long help to be the same, then the same string should be displayed both inprogram --help
andprogram withcommand --help
, without me having to specify it twice.Maybe also something like,
make_default_short_help
would use first line of long help, or maybe first sentence (help.split(r'\w\.\b')
)?The text was updated successfully, but these errors were encountered: