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

Customize usage in detail by splitting Help.detailedSynopsis #569

Closed
SysLord opened this issue Dec 17, 2018 · 2 comments
Closed

Customize usage in detail by splitting Help.detailedSynopsis #569

SysLord opened this issue Dec 17, 2018 · 2 comments
Milestone

Comments

@SysLord
Copy link
Contributor

SysLord commented Dec 17, 2018

When customizing the usage output with setSectionKeys or getSectionMap there is still a large part of the usage message created in Help.detailedSynopsis. One could either take the whole detailed synopsis as is or one would need to override the whole method.
Split Help.detailedSynopsis into meaningful methods. Enable the help sections (customized by setSectionKeys or getSectionMap) to customize the detailed synopsis in a finer grained manner.
Do not break the api (should be possible).
Suggested new help sections would be something like:

  • detailedOptions
  • detailedParameters
  • detailedCommandName

Probably not as simple as I initially thought because of how the texttable is built and because of abbreviatedSynopsis.

@SysLord SysLord changed the title Customize usage in detail by spliting Help.detailedSynopsis Customize usage in detail by splitting Help.detailedSynopsis Dec 17, 2018
@remkop
Copy link
Owner

remkop commented Dec 17, 2018

Thanks for raising this.
Can you provide some more detail on what you are trying to achieve? Some examples describing your specific use case(s) would be helpful.

@remkop remkop added this to the 3.9 milestone Dec 19, 2018
@remkop remkop closed this as completed in b25a106 Dec 19, 2018
@remkop
Copy link
Owner

remkop commented Dec 19, 2018

Merged into master. Please verify and confirm if this meets your needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants