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

default short help is too short #936

Closed
matejcik opened this issue Feb 22, 2018 · 3 comments
Closed

default short help is too short #936

matejcik opened this issue Feb 22, 2018 · 3 comments

Comments

@matejcik
Copy link
Contributor

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 and max_content_width of the context (as seen in #441).

I think I understand the intention behind separating help and short_help, and shortening the help if no separate short_help exists. I'd expect one of two things, though:

  • either applying max_content_width to short help and shortening based on terminal size,
  • or using short_help in place of help 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 in program --help and program 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'))?

@discosultan
Copy link

discosultan commented Mar 23, 2018

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
@dsully
Copy link
Contributor

dsully commented May 15, 2018

Merged #1002

@dsully dsully closed this as completed May 15, 2018
@ixaxaar
Copy link

ixaxaar commented Apr 17, 2019

Has this been removed since it was merged with #1008?
#1002 and #936 still persist.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants