help

Set the help for this argument.

Although you can also pass the help string as an argument to argument, this function can be more convenient for long help strings.

If you want to control the help string lazily or based on the context, you can pass a lambda that returns a string.

Example:

val number by argument()
     .int()
     .help("This is an argument that takes a number")

Set the help for this argument lazily.

You have access to the current Context if you need the theme or other information.

Example:

val number by argument()
     .int()
     .help { theme.info("This is an argument that takes a number") }