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

Review how "help" works #110

Open
jensdrenhaus opened this issue Nov 17, 2024 · 0 comments
Open

Review how "help" works #110

jensdrenhaus opened this issue Nov 17, 2024 · 0 comments

Comments

@jensdrenhaus
Copy link
Member

Initially, the idea was to print the help text of the main module of a command.

Alternative proposal:
Print the command's description followed by the help messages of all used modules.
The help messages of the modules should dynamically include the module configuration.

Maybe there should be two methods in the module interface instead of "help": "info" and "usage".
In the mentioned proposal, the "info" method is called on all modules of a command, except from the main module. For the main module, the "usage" function is called.

The "info" functions prints module information including configured settings, whereas the "usage" function gives information on what cmd line arguments can be used.

@jensdrenhaus jensdrenhaus added this to the Release v1.0.0 milestone Nov 17, 2024
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

1 participant