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
[Feature] Tagline in help text #2337
Comments
Submitted some code in #2338, to give it something real for discussion. |
My initial impression is that But I wonder if the default-command behaviour should only be triggered if there is a builder or handler? (Would this break any reasonable legacy use cases?) |
Having second thoughts about overloading A method called
(I need to do some more reading in the existing API to get a better idea of the existing patterns.) |
Red herring, the code supports |
I do see the subcommand description displayed in subcommand help in a very simple test program, but the description goes away when I add a custom usage. I see in #1830 (comment) that the subcommand description is actually not intended to be displayed in the subcommand help. So this is in line with what you thought, that the description is intended to appear in the list of subcommands. I note that a few of the example files put extra lines into the usage string. So that looks like the simple and historical work-around. yargs/example/line_count_options.js Line 3 in e517318
(Rather more complicated question than I expected!) |
Hello! I'd like to include a tagline in the help text. Maybe with a description function.
You can kind of do it with
usage()
, but it shows up in the commands list which I don't want.The epilog is also nice but it puts it at the end. I'd rather it have right up at the top as a nice header.
The text was updated successfully, but these errors were encountered: