qsharp-runtime
qsharp-runtime copied to clipboard
Consider improving the output of the `--help` option for boolean arguments in Q# standalone executables
Using the --help option when running a Q# standalone executable results on the following text for a program with a single entry-point operation that receives Int, Pauli and Bool arguments:
Usage:
Sample.RandomBit [options] [command]
Options:
--number-of-bits <number-of-bits> (REQUIRED)
--my-cool-pauli <PauliI|PauliX|PauliY|PauliZ> (REQUIRED)
--my-cool-bool (REQUIRED)
-s, --simulator <simulator> The name of the simulator to use.
--version Show version information
-?, -h, --help
In this output, it is unclear why a boolean option like --my-cool-bool is required.
Updating the output for --my-cool-bool option to the following would clarify this:
--my-cool-bool <true|false> (REQUIRED)