Documenting toolchains
You can write documentation for your toolchain in the DSL.
This will then show up when passing --help
argument, or when the command fails
Use @param <param-name>
to set the description for a specific parameter
documenting-toolchains.cli
hello-world {
"""
Does this very useful thing!
@param location - Location from where are you hello-world-in'.
@param dayOfWeek - Day of week when you are hello-world-in'.
"""
sub from(location: arg, dayOfWeek: arg) {
action 'echo Hello World from $(location) on this fine $(dayOfWeek)'
}
}
info
Documentation works on both root and sub toolchains