Refinitiv / websocket-api

A direct access WebSocket API that enables easy integration into a multitude of client technology environments such as scripting and web.
Other
68 stars 40 forks source link

C# MarketPriceAuthEx: Longer help screen, and add --help option #5

Closed apjanke closed 3 years ago

apjanke commented 4 years ago

What do you think about a longer, more descriptive help screen, and a --help option to allow users to explicitly access it without causing a failed process run? (Running the --help option in this PR results in a successful exit status.)

I think this form of the help screen is more readable, because the old version ends up wrapping the long list of options across multiple lines. It also includes descriptions for some of the options that might be ambiguous or non-obvious.

And the old version left out some of the alternate calling forms for options that have both short and long forms, like -h/--hostname.

Also, in help screens, it's conventional to put values that the user is supposed to replace with their own text in <...> angle brackets. This PR does that.

Also, the old version of the help screen describes System.AppDomain.CurrentDomain.FriendlyName as a command you can directly run from the command line. That doesn't work; in .NET Core, the compiled program is a DLL that you need to run with the dotnet command. This PR corrects the help screen to reflect that.

apjanke commented 4 years ago

BTW, I have signed and emailed in an Individual Contributor License Agreement.