Usage string should display brackets for optional parameters

[rojepp]

It is customary to display optional parameters with brackets:

        --input <string>: The input file to read
        --sqlconnection <string> <string>: The sql server and database.
        [--sqlcredentials <string> <string>]: User and password for the database.
If not given, Windows authentication is assumed.
        --help [-h|/h|/help|/?]: display this list of options.

[eiriktsarpalis]

In my use cases most of the arguments are optional, so not too sure about this. Perhaps the converse would be required, denoting that arguments are mandatory?

[rojepp]

Using brackets for optional params is pretty standard. I'd rather you didn't come up with a standard for the reverse. ;)

[eiriktsarpalis]

I would expect that bracket notation is usually kept for the first line of the usage string. Have you tried this?

parseResults.Usage(message = "Usage: cmd -foo [-bar]")

[rojepp]

Good point! Maybe there should be an option to generate the usage string
automatically?

On Wed, Oct 8, 2014 at 5:38 PM, Eirik Tsarpalis notifications@github.com
wrote:

I would expect that bracket notation is usually kept for the first line of
the usage string. Have you tried this?

parseResults.Usage(message = "Usage: cmd -foo [-bar]")

—
Reply to this email directly or view it on GitHub
#21 (comment)
.

[eiriktsarpalis]

Yeah, that sounds like a good idea.

On Wed, Oct 8, 2014 at 10:38 PM, Robert Jeppesen notifications@github.com
wrote:

Good point! Maybe there should be an option to generate the usage string
automatically?

On Wed, Oct 8, 2014 at 5:38 PM, Eirik Tsarpalis notifications@github.com

wrote:

I would expect that bracket notation is usually kept for the first line
of
the usage string. Have you tried this?

parseResults.Usage(message = "Usage: cmd -foo [-bar]")

—
Reply to this email directly or view it on GitHub
<
https://github.com/nessos/UnionArgParser/issues/21#issuecomment-58377752>
.

—
Reply to this email directly or view it on GitHub
#21 (comment)
.

[eiriktsarpalis]

Should I assume that the issue was resolved by PR #25?