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

Where should I put long help text? #1469

Closed
Niryo opened this issue Feb 7, 2021 · 5 comments
Closed

Where should I put long help text? #1469

Niryo opened this issue Feb 7, 2021 · 5 comments

Comments

@Niryo
Copy link
Contributor

Niryo commented Feb 7, 2021

I want to add some long help text, that tells in details how to use some command.
The description prop should be short (because it's being printed from out side the command), and I see that the "usage" support is not the correct place for such a long help message...
what prop should I use?

@shadowspawn
Copy link
Collaborator

Have a look at the the README section on custom help which covers .addHelpText().

Related issues: #898 #1291

@Niryo
Copy link
Contributor Author

Niryo commented Feb 8, 2021

thanks, it solved my problem. I think it worth considering adding an explicit prop for this, something like .extraInfo() or .detailedInfo() or even .documentation(). The current api for this is not intuitive.

@shadowspawn
Copy link
Collaborator

An answer was provided, and no further activity in a month. Closing this as resolved.

Feel free to open a new issue if it comes up again, with new information and renewed interest.

@shadowspawn
Copy link
Collaborator

Opened a PR to add .summary() for a short summary to use when listing subcommands.

@Niryo
Copy link
Contributor Author

Niryo commented May 18, 2022

Amazing! Thanks

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

No branches or pull requests

2 participants