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

Add a Global Options section to help docs #7153

Closed
wants to merge 1 commit into from

Conversation

hssyoo
Copy link
Contributor

@hssyoo hssyoo commented Aug 1, 2022

We get a lot of requests from users to include global options in a command's help page. The changes in this PR passes the global args table created once by the CLIDriver to the help commands that generate help docs. The global args table is used to generate a new Global Options section in the help docs.
The changes are currently only applied to standard commands, and does not include customizations.

image

'building-top-level-params',
'building-command-table.main',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to change the order of these events because the global arg table must be built as part of the _build_builtin_commands method which gets run before the session emits a building-command-table.main event.

@hssyoo
Copy link
Contributor Author

hssyoo commented Aug 2, 2022

Closing this in favor of #7157

@hssyoo hssyoo closed this Aug 2, 2022
@hssyoo hssyoo deleted the include-global-options-param branch August 3, 2022 16:24
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

Successfully merging this pull request may close these issues.

1 participant