You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: