CommandHelp
CommandHelp encapsulates the information needed to generate a user help message for a given CommandSpec, optionally with a specific command identified to print help about. Use Help.general()
or Help.for_command()
to create a CommandHelp instance.
class box CommandHelp
Public Functions
fullname
fun box fullname()
: String val
Returns
- String val
string
fun box string()
: String val
Returns
- String val
help_string
Renders the help message as a String.
fun box help_string()
: String val
Returns
- String val
print_help
Prints the help message to an OutStream.
fun box print_help(
os: OutStream tag)
: None val
Parameters
- os: OutStream tag
Returns
- None val
© 2016-2020, The Pony Developers
© 2014-2015, Causality Ltd.
Licensed under the BSD 2-Clause License.
https://stdlib.ponylang.io/cli-CommandHelp