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 new documentation annotation for program level help text #21

Open
jk-1 opened this issue Jun 2, 2022 · 0 comments
Open

Add new documentation annotation for program level help text #21

jk-1 opened this issue Jun 2, 2022 · 0 comments

Comments

@jk-1
Copy link

jk-1 commented Jun 2, 2022

Please add new documentation annotation for program level help text. Place for this text could be before "Available subcommands:" so at the very top or at the bottom or both depending on the size of the program. If just one place accepted then I prefer to place it at the bottom.

Annotations could be e.g. @begindoc, @enddoc

Program level help text should be visible when user runs program --help -command.

Reason: Many larger programs contain multiple subcommands and are part of a longer task process. A subcommand help contains instructions how to run that subcommand but program level documentation can help the user to understand the longer process:
What subcommands are run in what order, describle one or more simple workflows how to use subcommands to manage the whole task process from begin to end.

Program level help text can also be used for any other information common to all / multiple subcommands, where to find more information, author of the program, copyright etc.

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