Skip to content
This repository has been archived by the owner on Nov 21, 2021. It is now read-only.

ArgsInterpreter: Usage message for single-command mode #54

Open
rolandweber opened this issue Jun 27, 2017 · 1 comment
Open

ArgsInterpreter: Usage message for single-command mode #54

rolandweber opened this issue Jun 27, 2017 · 1 comment

Comments

@rolandweber
Copy link
Owner

The usage message for the single-command mode is poorly constructed. There's no place to describe the behavior or the single command before the arguments are listed.

Example output from a Follow-the-Board client:

Command-line arguments:
<host> <port> [<arg> [...]]

where:
<host> - hostname or IP address to connect to
<port> - port number to connect to

Arguments:
[<interval>]
  follow the board, with polling interval in seconds

The Arguments: line is provided by the base class. Maybe just remove that, so the command handler can provide a description as suitable?

@rolandweber
Copy link
Owner Author

rolandweber commented Oct 8, 2018

Simply removing the Arguments: line won't do. Further up, the [<arg> [...]]is also provided by the base class. After the Arguments: line follows a more detailed description of what these arguments are.

Maybe allow the single command to supply a replacement for [<arg> [...]]?

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

No branches or pull requests

1 participant